net.simplace.processors.FeatureCollectionInfoProcessor

Version: 1.0

This processor delivers informations of a org.geotools.feature.FeatureCollection and one special org.opengis.feature.Feature. Because the format the geometry informations of the feature differs with the geometry type of the org.geotools.feature.FeatureCollection, this class only provides general information about the collection (processFeature(SimpleFeature)is empty!. These informations are stored in the output parameter map under the following keys (+ prefix):

featureCount: Count of features
crs: CRS as org.opengis.referencing.crs.CoordinateReferenceSystem
crs.wkt: WKT specification of the CRS
geomType: Class of the geometry attribute
attrCount: Count of attributes of one feature
geomAttrName: Name of the default geometry attribute
attr.: Value of the attribute "attrName" of the specified feature

Required input parameters:

Key featureCollectionParamKey: key where to find the org.geotools.feature.FeatureCollection. Also a de.schmitzm.geotools.styling.StyledFeatureCollectionInterface is allowed.
Key outParamPrefix: Prefix used to store the upper mentioned output parameters (e.g. with prefix barrages the geometry type is stored under barrages.geomType).
Key featureIdx (optional): Number of the feature informations are taken from (starting with 0).
Key featureRule (optional): Rule for de.schmitzm.geotools.feature.FeatureOperationTreeFilter to determine the feature the informations are taken from.

If featureIdx is not specified, the first feature is used. If featureRule and featureIdx are specified, first the rule is applied and the index is used relative to the filter result. If neither featureIdx nor featureRule is specified, the first feature of all is used.

public class FeatureCollectionInfoProcessor extends
net.simplace.util.pipeline.FWProcessor {
// Public Constructors
public FeatureCollectionInfoProcessor();

// Constants
public static final String INKEY_FC;
public static final String INKEY_OUTPREFIX;
public static final String INKEY_FIDX;
public static final String INKEY_FRULE;
public static final String OUTKEY_FCOUNT;
public static final String OUTKEY_ACOUNT;
public static final String OUTKEY_GTYPE;
public static final String OUTKEY_GNAME;
public static final String OUTKEY_GIDX;
public static final String OUTKEY_CRS;
public static final String OUTKEY_CRSWKT;

// Public Instance Methods

public boolean checkInParameterMap(); // Defines
net.simplace.util.pipeline.FWProcessor

Checks whether the in-channel contains all required parameters.

public void processFeature(SimpleFeature aFeature) throws Exception;

Stores informations about the given org.opengis.feature.Feature in the output parameter map. This method stores the attribute values in the out parameters "attr.". Sub-classes must override this method to store (geometry dependent) informations in the output parameter map.
Note:

super.processFeature(.) should be called.
This method is also called if no feature could be determined. In this case aFeature is null and the sub-class method must initialize its output parameters.
net.simplace.processors.FeatureCollectionInfoProcessor.setOutParameter(String, Object) already puts the prefix to the key, so only the suffix must be specified when using net.simplace.processors.FeatureCollectionInfoProcessor.setOutParameter(String, Object)!

aFeature the feature, informations should be provided about

// Protected Instance Methods

protected boolean process() throws PipeLineException; // Defines
net.simplace.util.pipeline.FWProcessor

Stores informations about the org.geotools.feature.FeatureCollection in the output parameter map.
returns ever {@code true}

protected void setOutParameter(String aKey, Object aValue);
// Defines net.simplace.util.pipeline.FWProcessor

Overrides the super method to put the prefix to the key automatically.

}

Hierarchy: java.lang.Object - net.simplace.util.pipeline.FWProcessor - FeatureCollectionInfoProcessor

Extended by: LineFeatureCollectionInfoProcessor, PointFeatureCollectionInfoProcessor