Class ContentFeatureCollection
- Object
-
- ContentFeatureCollection
-
- All Implemented Interfaces:
SimpleFeatureCollection
,FeatureCollection<SimpleFeatureType,SimpleFeature>
public class ContentFeatureCollection extends Object implements SimpleFeatureCollection
A FeatureCollection that completely delegates to a backing FetaureSource#getReader- Author:
- Jody Garnett (Refractions Research, Inc.)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ContentFeatureCollection.WrappingFeatureIterator
-
Field Summary
Fields Modifier and Type Field Description protected ContentFeatureSource
featureSource
feature store the collection originated from.protected SimpleFeatureType
featureType
feature (possibly retyped from feautre source original) typeprotected static Logger
LOGGER
protected Query
query
protected ContentState
state
state of the feature source
-
Constructor Summary
Constructors Modifier Constructor Description protected
ContentFeatureCollection(ContentFeatureSource featureSource, 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
contains(Object o)
Returns true if this collection contains the specified element.boolean
containsAll(Collection<?> c)
Returns true if this collection contains all of the elements in the specified collection.SimpleFeatureIterator
features()
Obtain a SimpleFeatureIterator of the Features within this SimpleFeatureCollection.ReferencedEnvelope
getBounds()
Get the total bounds of this collection which is calculated by doing a union of the bounds of each feature inside of itString
getID()
ID used when serializing to GMLSimpleFeatureType
getSchema()
The schema for the child feature members of this collection.boolean
isEmpty()
Returns true if this feature collection contains no features.boolean
remove(Object o)
int
size()
Please note this operation may be expensive when working with remote content.SimpleFeatureCollection
sort(SortBy sort)
Obtained sorted contents.SimpleFeatureCollection
subCollection(Filter filter)
SimpleFeatureCollection "view" indicated by provided filter.Object[]
toArray()
Array of all the elements.<T> T[]
toArray(T[] array)
-
-
-
Field Detail
-
LOGGER
protected static final Logger LOGGER
-
featureSource
protected ContentFeatureSource featureSource
feature store the collection originated from.
-
query
protected Query query
-
featureType
protected SimpleFeatureType featureType
feature (possibly retyped from feautre source original) type
-
state
protected ContentState state
state of the feature source
-
-
Constructor Detail
-
ContentFeatureCollection
protected ContentFeatureCollection(ContentFeatureSource featureSource, Query query)
-
-
Method Detail
-
getSchema
public SimpleFeatureType 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<SimpleFeatureType,SimpleFeature>
- Returns:
- FeatureType describing the "common" schema to all child features of this collection
-
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<SimpleFeatureType,SimpleFeature>
- Parameters:
visitor
- Closure applied to each feature in turn.progress
- Used to report progress, may be used to interrupt the operation- Throws:
IOException
-
features
public SimpleFeatureIterator features()
Description copied from interface:SimpleFeatureCollection
Obtain a SimpleFeatureIterator of the Features within this SimpleFeatureCollection.The implementation of FeatureIterator must adhere to the rules of fail-fast concurrent modification. In addition (to allow for resource backed collections) the
SimpleFeatureIterator.close()
method must be called.Example use:
SimpleFeatureIterator iterator=collection.features(); try { while( iterator.hasNext() ){ SimpleFeature feature = iterator.next(); System.out.println( feature.getID() ); } } finally { iterator.close(); }
- Specified by:
features
in interfaceFeatureCollection<SimpleFeatureType,SimpleFeature>
- Specified by:
features
in interfaceSimpleFeatureCollection
- Returns:
- A FeatureIterator.
-
getBounds
public ReferencedEnvelope getBounds()
Description copied from interface:FeatureCollection
Get the total bounds of this collection which is calculated by doing a union of the bounds of each feature inside of it- Specified by:
getBounds
in interfaceFeatureCollection<SimpleFeatureType,SimpleFeature>
- Returns:
- An Envelope containing the total bounds of this collection.
-
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<SimpleFeatureType,SimpleFeature>
- See Also:
Collection.size()
-
isEmpty
public boolean isEmpty()
Description copied from interface:FeatureCollection
Returns true if this feature collection contains no features.- Specified by:
isEmpty
in interfaceFeatureCollection<SimpleFeatureType,SimpleFeature>
- Returns:
- true if this collection contains no features
-
sort
public SimpleFeatureCollection sort(SortBy sort)
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<SimpleFeatureType,SimpleFeature>
- Specified by:
sort
in interfaceSimpleFeatureCollection
- Parameters:
sort
- Sort order- Returns:
- FeatureCollection sorted in the indicated order
-
subCollection
public SimpleFeatureCollection 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<SimpleFeatureType,SimpleFeature>
- Specified by:
subCollection
in interfaceSimpleFeatureCollection
- Returns:
- SimpleFeatureCollection identified as subset.
- See Also:
FeatureList
-
contains
public boolean contains(Object o)
Returns true if this collection contains the specified element. .This implementation iterates over the elements in the collection, checking each element in turn for equality with the specified element.
- Specified by:
contains
in interfaceFeatureCollection<SimpleFeatureType,SimpleFeature>
- Parameters:
o
- object to be checked for containment in this collection.- Returns:
- true if this collection contains the specified element.
- See Also:
Collection.contains(Object)
-
containsAll
public boolean containsAll(Collection<?> c)
Returns true if this collection contains all of the elements in the specified collection.- Specified by:
containsAll
in interfaceFeatureCollection<SimpleFeatureType,SimpleFeature>
- Parameters:
c
- collection to be checked for containment in this collection.- Returns:
- true if this collection contains all of the elements in the specified collection.
- Throws:
NullPointerException
- if the specified collection is null.- See Also:
contains(Object)
-
remove
public boolean remove(Object o)
-
toArray
public Object[] toArray()
Array of all the elements.- Specified by:
toArray
in interfaceFeatureCollection<SimpleFeatureType,SimpleFeature>
- Returns:
- an array containing all of the elements in this collection.
- See Also:
Collection.toArray()
-
toArray
public <T> T[] toArray(T[] array)
- Specified by:
toArray
in interfaceFeatureCollection<SimpleFeatureType,SimpleFeature>
- See Also:
Collection.toArray(Object[])
-
getID
public String getID()
Description copied from interface:FeatureCollection
ID used when serializing to GML- Specified by:
getID
in interfaceFeatureCollection<SimpleFeatureType,SimpleFeature>
-
-