ilog.views.maps.filters
Class IlvSplitFeatureFilter

java.lang.Object
  ilog.views.maps.datasource.IlvHierarchicalDataSource.CriterionFilter
      ilog.views.maps.datasource.IlvHierarchicalDataSource.SingleAttributeFilter
          ilog.views.maps.filters.IlvSplitFeatureFilter

All Implemented Interfaces:

IlvPersistentObject

Direct Known Subclasses:

IlvSplitContainsFilter, IlvSplitEndsFilter, IlvSplitEqualsFilter, IlvSplitGreaterOrEqualFilter, IlvSplitGreaterThanFilter, IlvSplitStartsFilter

public abstract class IlvSplitFeatureFilter
extends IlvHierarchicalDataSource.SingleAttributeFilter

Base filter that is compared to a reference value.

Since:

JViews 8.0

See Also:

IlvSplitDataSource

Field Summary

protected String	reference Reference value.
static int	RESULT_BOTH Result type indicating that all features should be kept.
static int	RESULT_NOK Result type indicating that only the features not matching the filter should be kept.
static int	RESULT_OK Result type indicating that only the features matching the filter should be kept.
protected int	resultType Type of result: keep matching, non matching or both.

Constructor Summary

IlvSplitFeatureFilter(IlvInputStream stream)
Creates a new IlvSplitFeatureFilter.

IlvSplitFeatureFilter(String propertyName, String description, String ref, int resultType)
Creates a new IlvSplitFeatureFilter.

Method Summary

Object	getValue(IlvMapFeature feature) Returns a value for the specified map feature.
void	write(IlvOutputStream stream) Writes this filter to a IlvOutputStream

Methods inherited from class ilog.views.maps.datasource.IlvHierarchicalDataSource.SingleAttributeFilter

getAttributeDescription, getAttributeName, getCriterionDescription, setAttributeDescription, setAttributeName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RESULT_OK

public static final int RESULT_OK

Result type indicating that only the features matching the filter should be kept.

See Also:

Constant Field Values

RESULT_NOK

public static final int RESULT_NOK

Result type indicating that only the features not matching the filter should be kept.

See Also:

Constant Field Values

RESULT_BOTH

public static final int RESULT_BOTH

Result type indicating that all features should be kept.

See Also:

Constant Field Values

reference

protected final String reference

Reference value.

resultType

protected final int resultType

Type of result: keep matching, non matching or both.

Constructor Detail

IlvSplitFeatureFilter

public IlvSplitFeatureFilter(IlvInputStream stream)
                      throws IlvReadFileException

Creates a new IlvSplitFeatureFilter.

Parameters:

stream - The stream to read the filter definition from.

Throws:

IlvReadFileException - if fields are missing

IlvSplitFeatureFilter

public IlvSplitFeatureFilter(String propertyName,
                             String description,
                             String ref,
                             int resultType)

Creates a new IlvSplitFeatureFilter.

Parameters:

propertyName - The property name to check.

description - The description of the filter (unused).

ref - The reference value.

resultType - The type of the resulting layers. The result type should be one of:

• RESULT_OK
• RESULT_NOK
• RESULT_BOTH

Method Detail

getValue

public Object getValue(IlvMapFeature feature)

Returns a value for the specified map feature. It returns the value of the attribute associated with this filter, if any. Null otherwise.

Overrides:

getValue in class IlvHierarchicalDataSource.SingleAttributeFilter

Parameters:

feature - the specified map feature.

Returns:

the value for the specified map feature.

write

public void write(IlvOutputStream stream)
           throws IOException

Writes this filter to a IlvOutputStream

Specified by:

write in interface IlvPersistentObject

Overrides:

write in class IlvHierarchicalDataSource.SingleAttributeFilter

Parameters:

stream - The stream to write to.

Throws:

IOException - thrown when an exception occurs during the write operation for this object.