MaxSimpleFeatureCollection (Geotools modules 26-SNAPSHOT API)

Object
- DecoratingSimpleFeatureCollection
- - MaxSimpleFeatureCollection

All Implemented Interfaces:

SimpleFeatureCollection, FeatureCollection<SimpleFeatureType,SimpleFeature>
```
public class MaxSimpleFeatureCollection
extends DecoratingSimpleFeatureCollection
```
SimpleFeatureCollection wrapper which limits the number of features returned.

Author:

Justin Deoliveira, The Open Planning Project

Constructor Summary

Constructors
Constructor and Description
`MaxSimpleFeatureCollection(FeatureCollection<SimpleFeatureType,SimpleFeature> delegate, long max)`
`MaxSimpleFeatureCollection(SimpleFeatureCollection delegate, long max)`
`MaxSimpleFeatureCollection(SimpleFeatureCollection delegate, long start, long max)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`containsAll(Collection<?> c)`
`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
`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()`
`<T> T[]`	`toArray(T[] a)`

Methods inherited from class DecoratingSimpleFeatureCollection
accepts, canDelegate, contains, equals, getID, getSchema, hashCode

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

- Constructor Detail
  - MaxSimpleFeatureCollection
```
public MaxSimpleFeatureCollection(FeatureCollection<SimpleFeatureType,SimpleFeature> delegate,
                                  long max)
```
  - MaxSimpleFeatureCollection
```
public MaxSimpleFeatureCollection(SimpleFeatureCollection delegate,
                                  long max)
```
  - MaxSimpleFeatureCollection
```
public MaxSimpleFeatureCollection(SimpleFeatureCollection delegate,
                                  long start,
                                  long max)
```
- Method Detail
  - 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>
    
    Overrides:
    
    features in class DecoratingSimpleFeatureCollection
    
    Returns:
    
    A FeatureIterator.
  - 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>
    
    Overrides:
    
    subCollection in class DecoratingSimpleFeatureCollection
    
    Returns:
    
    SimpleFeatureCollection identified as subset.
    
    See Also:
    
    FeatureList
  - 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>
    
    Overrides:
    
    sort in class DecoratingSimpleFeatureCollection
    
    Parameters:
    
    order - Sort order
    
    Returns:
    
    FeatureCollection sorted in the indicated order
  - 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>
    
    Overrides:
    
    size in class DecoratingSimpleFeatureCollection
    
    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 interface FeatureCollection<SimpleFeatureType,SimpleFeature>
    
    Overrides:
    
    isEmpty in class DecoratingSimpleFeatureCollection
    
    Returns:
    
    true if this collection contains no features
  - toArray
```
public Object[] toArray()
```
    Specified by:
    
    toArray in interface FeatureCollection<SimpleFeatureType,SimpleFeature>
    
    Overrides:
    
    toArray in class DecoratingSimpleFeatureCollection
    
    See Also:
    
    Collection.toArray()
  - toArray
```
public <T> T[] toArray(T[] a)
```
    Specified by:
    
    toArray in interface FeatureCollection<SimpleFeatureType,SimpleFeature>
    
    Overrides:
    
    toArray in class DecoratingSimpleFeatureCollection
    
    See Also:
    
    Collection.toArray(Object[])
  - containsAll
```
public boolean containsAll(Collection<?> c)
```
    Specified by:
    
    containsAll in interface FeatureCollection<SimpleFeatureType,SimpleFeature>
    
    Overrides:
    
    containsAll in class DecoratingSimpleFeatureCollection
    
    See Also:
    
    Collection.containsAll(Collection)
  - 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>
    
    Overrides:
    
    getBounds in class DecoratingSimpleFeatureCollection
    
    Returns:
    
    An Envelope containing the total bounds of this collection.

Class MaxSimpleFeatureCollection

Constructor Summary

Method Summary

Methods inherited from class DecoratingSimpleFeatureCollection

Methods inherited from class Object

Constructor Detail

MaxSimpleFeatureCollection

MaxSimpleFeatureCollection

MaxSimpleFeatureCollection

Method Detail

features

subCollection

sort

size

isEmpty

toArray

toArray

containsAll

getBounds