Class MappingFeatureCollection
- Object
-
- MappingFeatureCollection
-
- All Implemented Interfaces:
FeatureCollection<FeatureType,Feature>
public class MappingFeatureCollection extends Object implements FeatureCollection<FeatureType,Feature>
FeatureCollection
for aMappingFeatureIterator
.- Since:
- 2.6
- Author:
- Ben Caradoc-Davies (CSIRO Earth Science and Resource Engineering)
-
-
Constructor Summary
Constructors Constructor Description MappingFeatureCollection(AppSchemaDataAccess store, FeatureTypeMapping mapping, Query query)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accepts(FeatureVisitor visitor, ProgressListener progress)
Visit the contents of a feature collection.boolean
add(Feature obj)
Not a supported operation.boolean
addAll(Collection<? extends Feature> collection)
boolean
addAll(FeatureCollection<? extends FeatureType,? extends Feature> resource)
void
addListener(CollectionListener listener)
void
clear()
void
close(Iterator<Feature> close)
void
close(FeatureIterator<Feature> close)
boolean
contains(Object o)
boolean
containsAll(Collection<?> o)
FeatureIterator<Feature>
features()
Obtain a FeatureIteratorof the Features within this FeatureCollection. XmlMappingFeatureIterator
features(String xpath, String value)
FeatureIterator<Feature>
features(Transaction transaction)
This overload allows client code to explicitly specify the transaction that the created iterator will be working against.ReferencedEnvelope
getBounds()
Stolen fromReprojectFeatureResults
.String
getID()
ID used when serializing to GMLQuery
getQuery()
FeatureType
getSchema()
The schema for the child feature members of this collection.boolean
isEmpty()
Returns true if this feature collection contains no features.boolean
isXmlCollection()
Iterator<Feature>
iterator()
void
purge()
boolean
remove(Object o)
boolean
removeAll(Collection<?> c)
void
removeListener(CollectionListener listener)
boolean
retainAll(Collection<?> c)
void
setUnrolledFilter(Filter unrolledFilter)
int
size()
Please note this operation may be expensive when working with remote content.FeatureCollection<FeatureType,Feature>
sort(SortBy order)
Obtained sorted contents.FeatureCollection<FeatureType,Feature>
subCollection(Filter filter)
SimpleFeatureCollection "view" indicated by provided filter.Object[]
toArray()
<O> O[]
toArray(O[] a)
-
-
-
Constructor Detail
-
MappingFeatureCollection
public MappingFeatureCollection(AppSchemaDataAccess store, FeatureTypeMapping mapping, Query query)
-
-
Method Detail
-
setUnrolledFilter
public void setUnrolledFilter(Filter unrolledFilter)
-
accepts
public void accepts(FeatureVisitor visitor, ProgressListener progress) throws IOException
Description copied from interface:FeatureCollection
Visit the contents of a feature collection.The order of traversal is dependent on the FeatureCollection implementation; some collections are able to make efficient use of an internal index in order to quickly visit features located in the same region.
- Specified by:
accepts
in interfaceFeatureCollection<FeatureType,Feature>
- Parameters:
visitor
- Closure applied to each feature in turn.progress
- Used to report progress, may be used to interrupt the operation- Throws:
IOException
- See Also:
FeatureCollection.accepts(org.geotools.api.feature.FeatureVisitor, org.geotools.api.util.ProgressListener)
-
add
public boolean add(Feature obj)
Not a supported operation.- See Also:
org.geotools.feature.FeatureCollection#add(org.geotools.api.feature.Feature)
-
addAll
public boolean addAll(Collection<? extends Feature> collection)
-
addAll
public boolean addAll(FeatureCollection<? extends FeatureType,? extends Feature> resource)
-
addListener
public void addListener(CollectionListener listener) throws NullPointerException
- Throws:
NullPointerException
-
clear
public void clear()
-
close
public void close(FeatureIterator<Feature> close)
-
contains
public boolean contains(Object o)
- Specified by:
contains
in interfaceFeatureCollection<FeatureType,Feature>
- See Also:
Collection.contains(Object)
-
containsAll
public boolean containsAll(Collection<?> o)
- Specified by:
containsAll
in interfaceFeatureCollection<FeatureType,Feature>
- See Also:
Collection.containsAll(Collection)
-
features
public FeatureIterator<Feature> features()
Description copied from interface:FeatureCollection
Obtain a FeatureIteratorof the Features within this FeatureCollection. The implementation of FeatureIterator must adhere to the rules of fail-fast concurrent modification. In addition (to allow for resource backed collections) the
FeatureIterator.close()
method must be called.Example use:
FeatureIterator
iterator=collection.features(); try { while( iterator.hasNext() ){ Feature feature = iterator.next(); System.out.println( feature.getID() ); } } finally { iterator.close(); } GML Note: The contents of this iterator are considered to be defined by featureMember tags (and/or the single allowed FeatureMembers tag). Please see getFeatureType for more details.
- Specified by:
features
in interfaceFeatureCollection<FeatureType,Feature>
- Returns:
- A FeatureIterator.
-
features
public FeatureIterator<Feature> features(Transaction transaction)
This overload allows client code to explicitly specify the transaction that the created iterator will be working against.Passing
null
is equivalent to callingfeatures()
and lets the iterator decide whether a new transaction should be created (and closed when the iterator is closed) or not. Currently, a new transaction is created byDataAccessMappingFeatureIterator
only if a database backend is available and joining is enabled, to reduce the number of concurrent connections opened due to feature chaining.- Parameters:
transaction
- the transaction the created iterator will be working against- See Also:
FeatureCollection.features()
-
features
public XmlMappingFeatureIterator features(String xpath, String value) throws IOException
- Throws:
IOException
-
getBounds
public ReferencedEnvelope getBounds()
Stolen fromReprojectFeatureResults
.- Specified by:
getBounds
in interfaceFeatureCollection<FeatureType,Feature>
- Returns:
- An Envelope containing the total bounds of this collection.
- See Also:
FeatureCollection.getBounds()
-
getID
public String getID()
Description copied from interface:FeatureCollection
ID used when serializing to GML- Specified by:
getID
in interfaceFeatureCollection<FeatureType,Feature>
-
getSchema
public FeatureType getSchema()
Description copied from interface:FeatureCollection
The schema for the child feature members of this collection.Represents the most general FeatureType in common to all the features in this collection.
- For a collection backed by a shapefiles (or database tables) the FeatureType returned by getSchema() will complete describe each and every child in the collection.
- For mixed content FeatureCollections you will need to check the FeatureType of each Feature as it is retrived from the collection
- The degenerate case returns the "_Feature" FeatureType, where the only thing known is that the contents are Features.
- Specified by:
getSchema
in interfaceFeatureCollection<FeatureType,Feature>
- Returns:
- FeatureType describing the "common" schema to all child features of this collection
-
isEmpty
public boolean isEmpty()
Description copied from interface:FeatureCollection
Returns true if this feature collection contains no features.- Specified by:
isEmpty
in interfaceFeatureCollection<FeatureType,Feature>
- Returns:
- true if this collection contains no features
-
purge
public void purge()
-
remove
public boolean remove(Object o)
-
removeAll
public boolean removeAll(Collection<?> c)
-
removeListener
public void removeListener(CollectionListener listener) throws NullPointerException
- Throws:
NullPointerException
-
retainAll
public boolean retainAll(Collection<?> c)
-
size
public int size()
Description copied from interface:FeatureCollection
Please note this operation may be expensive when working with remote content.- Specified by:
size
in interfaceFeatureCollection<FeatureType,Feature>
- See Also:
Collection.size()
-
sort
public FeatureCollection<FeatureType,Feature> sort(SortBy order)
Description copied from interface:FeatureCollection
Obtained sorted contents.This method may not be supported by all implementations, consider the use of FeatureSource.features( Query ).
- Specified by:
sort
in interfaceFeatureCollection<FeatureType,Feature>
- Parameters:
order
- Sort order- Returns:
- FeatureCollection sorted in the indicated order
-
isXmlCollection
public boolean isXmlCollection()
-
subCollection
public FeatureCollection<FeatureType,Feature> subCollection(Filter filter)
Description copied from interface:FeatureCollection
SimpleFeatureCollection "view" indicated by provided filter.The contents of the returned SimpleFeatureCollection are determined by applying the provider Filter to the entire contents of this FeatureCollection. The result is "live" and modifications will be shared.
This method is used cut down on the number of filter based methods required for a useful SimpleFeatureCollection construct. The FeatureCollections returned really should be considered as a temporary "view" used to control the range of a removeAll, or modify operation.
Example Use:
The above recommended use is agreement with the Collections API precident of List.subList( start, end ).collection.subCollection( filter ).clear();
The results of subCollection:
- are to be considered unordered
- may be an ordered FeatureList if requested when sortBy is indicated
- Specified by:
subCollection
in interfaceFeatureCollection<FeatureType,Feature>
- Returns:
- SimpleFeatureCollection identified as subset.
- See Also:
FeatureList
-
toArray
public Object[] toArray()
- Specified by:
toArray
in interfaceFeatureCollection<FeatureType,Feature>
- See Also:
Collection.toArray()
-
toArray
public <O> O[] toArray(O[] a)
- Specified by:
toArray
in interfaceFeatureCollection<FeatureType,Feature>
- See Also:
Collection.toArray(Object[])
-
getQuery
public Query getQuery()
-
-