ilog.views.maps.datasource
Class IlvHierarchicalDataSource.SingleAttributeFilter

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

All Implemented Interfaces:

IlvPersistentObject

Direct Known Subclasses:

IlvDefaultFeatureFilter, IlvExplodeFilter, IlvSplitFeatureFilter, IlvTigerDataSource.CFCCFilter

Enclosing class:

IlvHierarchicalDataSource

public static class IlvHierarchicalDataSource.SingleAttributeFilter
extends IlvHierarchicalDataSource.CriterionFilter

A specialized criterion filter that returns the value of an attribute of a map feature.

Since:

JViews 7.5

Constructor Summary

IlvHierarchicalDataSource.SingleAttributeFilter(IlvInputStream stream)
Constructs a SingleAttributeFilter from the specified stream.

IlvHierarchicalDataSource.SingleAttributeFilter(String attributeName, String attributeDescription)
Public constructor

Method Summary

String	getAttributeDescription() Gets the attribute description used by this filter.
String	getAttributeName() Returns the attribute name used by this filter to return a value for a map feature.
String	getCriterionDescription() Returns a description for this filter
Object	getValue(IlvMapFeature feature) Returns a value for the specified map feature.
void	setAttributeDescription(String attributeDescription) Sets the attribute description used by this filter.
void	setAttributeName(String attributeName) Sets the attribute name used by this filter to return a value for a map feature.
void	write(IlvOutputStream stream) Writes this filter to a IlvOutputStream

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvHierarchicalDataSource.SingleAttributeFilter

public IlvHierarchicalDataSource.SingleAttributeFilter(String attributeName,
                                                       String attributeDescription)

Public constructor

Parameters:

attributeName - the name of the attribute to look for

attributeDescription - a short description of the attribute

IlvHierarchicalDataSource.SingleAttributeFilter

public IlvHierarchicalDataSource.SingleAttributeFilter(IlvInputStream stream)
                                                throws IlvReadFileException

Constructs a SingleAttributeFilter from the specified stream.

Parameters:

stream - the IlvInputStream to read from.

Throws:

IlvReadFileException - exception thrown if an error was encountered when deserializing this object.

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.

Specified by:

getValue in class IlvHierarchicalDataSource.CriterionFilter

Parameters:

feature - the specified map feature.

Returns:

the value for the specified map feature.

getCriterionDescription

public String getCriterionDescription()

Returns a description for this filter

Specified by:

getCriterionDescription in class IlvHierarchicalDataSource.CriterionFilter

Returns:

a string describing the filter

getAttributeName

public String getAttributeName()

Returns the attribute name used by this filter to return a value for a map feature.

Returns:

the name of the attribute.

write

public void write(IlvOutputStream stream)
           throws IOException

Writes this filter to a IlvOutputStream

Parameters:

stream - The stream to write to.

Throws:

IOException

setAttributeName

public void setAttributeName(String attributeName)

Sets the attribute name used by this filter to return a value for a map feature.

Parameters:

attributeName - the name of the attribute.

Since:

JViews 7.5

getAttributeDescription

public String getAttributeDescription()

Gets the attribute description used by this filter.

Returns:

the description of the attribute.

Since:

JViews 7.5

setAttributeDescription

public void setAttributeDescription(String attributeDescription)

Sets the attribute description used by this filter.

Parameters:

attributeDescription - the description of the attribute.

Since:

JViews 7.5