DecoratingSimpleFeatureCollection (Geotools modules 23-SNAPSHOT API)

Object
- DecoratingSimpleFeatureCollection

All Implemented Interfaces:

SimpleFeatureCollection, FeatureCollection<SimpleFeatureType,SimpleFeature>

Direct Known Subclasses:

CollectionFeatureSource.SubCollection, FilteringSimpleFeatureCollection, MaxSimpleFeatureCollection, ReprojectingFeatureCollection, ReTypingFeatureCollection, SortedSimpleFeatureCollection
```
public class DecoratingSimpleFeatureCollection
extends Object
implements SimpleFeatureCollection
```
A FeatureCollection which completely delegates to another FeatureCollection.
This class should be subclasses by classes which must somehow decorate another SimpleFeatureCollection and override the relevant methods.

Since:

2.5

Author:

Justin Deoliveira, The Open Planning Project, jdeolive@openplans.org

Field Summary

Fields
Modifier and Type Field and Description

protected SimpleFeatureCollection delegate
the delegate

Fields
Modifier and Type	Field and Description
`protected SimpleFeatureCollection`	`delegate` the delegate

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`DecoratingSimpleFeatureCollection(FeatureCollection<SimpleFeatureType,SimpleFeature> delegate)`
`protected`	`DecoratingSimpleFeatureCollection(SimpleFeatureCollection delegate)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`accepts(FeatureVisitor visitor, ProgressListener progress)` Visit the contents of a feature collection.
`protected boolean`	`canDelegate(FeatureVisitor visitor)` Methods for subclass to override in order to determine if the supplied visitor can be passed to the delegate collection.
`boolean`	`contains(Object o)`
`boolean`	`containsAll(Collection<?> c)`
`boolean`	`equals(Object o)`
`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 it
`String`	`getID()` ID used when serializing to GML
`SimpleFeatureType`	`getSchema()` The schema for the child feature members of this collection.
`int`	`hashCode()`
`boolean`	`isEmpty()` Returns `true` if this feature collection contains no features.
`int`	`size()` Please note this operation may be expensive when working with remote content.
`SimpleFeatureCollection`	`sort(SortBy order)` Obtained sorted contents.
`SimpleFeatureCollection`	`subCollection(Filter filter)` SimpleFeatureCollection "view" indicated by provided filter.
`Object[]`	`toArray()`
`<F> F[]`	`toArray(F[] a)`

Methods inherited from class Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - delegate
```
protected SimpleFeatureCollection delegate
```
    the delegate
- Constructor Detail
  - DecoratingSimpleFeatureCollection
```
protected DecoratingSimpleFeatureCollection(FeatureCollection<SimpleFeatureType,SimpleFeature> delegate)
```
  - DecoratingSimpleFeatureCollection
```
protected DecoratingSimpleFeatureCollection(SimpleFeatureCollection delegate)
```
- Method Detail
  - 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 interface FeatureCollection<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
  - canDelegate
```
protected boolean canDelegate(FeatureVisitor visitor)
```
    Methods for subclass to override in order to determine if the supplied visitor can be passed to the delegate collection.
    The default is false and the visitor receives the decoraeted features.
  - contains
```
public boolean contains(Object o)
```
    Specified by:
    
    contains in interface FeatureCollection<SimpleFeatureType,SimpleFeature>
    
    See Also:
    
    Collection.contains(Object)
  - containsAll
```
public boolean containsAll(Collection<?> c)
```
    Specified by:
    
    containsAll in interface FeatureCollection<SimpleFeatureType,SimpleFeature>
    
    See Also:
    
    Collection.containsAll(Collection)
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - 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 interface SimpleFeatureCollection
    
    Specified by:
    
    features in interface FeatureCollection<SimpleFeatureType,SimpleFeature>
    
    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 interface FeatureCollection<SimpleFeatureType,SimpleFeature>
    
    Returns:
    
    An Envelope containing the total bounds of this collection.
  - 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 interface FeatureCollection<SimpleFeatureType,SimpleFeature>
    
    Returns:
    
    FeatureType describing the "common" schema to all child features of this collection
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: FeatureCollection
    
    Returns true if this feature collection contains no features.
    
    Specified by:
    
    isEmpty in interface FeatureCollection<SimpleFeatureType,SimpleFeature>
    
    Returns:
    
    true if this collection contains no features
  - 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 interface FeatureCollection<SimpleFeatureType,SimpleFeature>
    
    See Also:
    
    Collection.size()
  - sort
```
public SimpleFeatureCollection 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 interface SimpleFeatureCollection
    
    Specified by:
    
    sort in interface FeatureCollection<SimpleFeatureType,SimpleFeature>
    
    Parameters:
    
    order - 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:
```
 collection.subCollection( filter ).clear();
 
```
    The above recommended use is agreement with the Collections API precident of List.subList( start, end ).
    The results of subCollection:
    - are to be considered unordered
    - may be an ordered FeatureList if requested when sortBy is indicated
    Specified by:
    
    subCollection in interface SimpleFeatureCollection
    
    Specified by:
    
    subCollection in interface FeatureCollection<SimpleFeatureType,SimpleFeature>
    
    Returns:
    
    SimpleFeatureCollection identified as subset.
    
    See Also:
    
    FeatureList
  - toArray
```
public Object[] toArray()
```
    Specified by:
    
    toArray in interface FeatureCollection<SimpleFeatureType,SimpleFeature>
    
    See Also:
    
    Collection.toArray()
  - toArray
```
public <F> F[] toArray(F[] a)
```
    Specified by:
    
    toArray in interface FeatureCollection<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 interface FeatureCollection<SimpleFeatureType,SimpleFeature>

Class DecoratingSimpleFeatureCollection

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

delegate

Constructor Detail

DecoratingSimpleFeatureCollection

DecoratingSimpleFeatureCollection

Method Detail

accepts

canDelegate

contains

containsAll

equals

features

getBounds

getSchema

hashCode

isEmpty

size

sort

subCollection

toArray

toArray

getID