com.moximedia.ows.wfs
Class FilterFeatureId

java.lang.Object
  extended bycom.moximedia.ows.wfs.FilterFeatureId
All Implemented Interfaces:
Filter, java.io.Serializable

public class FilterFeatureId
extends java.lang.Object
implements Filter, java.io.Serializable

Implementation of OGC Filter encoding specification for "FeatureId".

Author:
Doug Cates - Moxi Media Inc.
See Also:
Serialized Form

Constructor Summary
FilterFeatureId()
          Creates a new empty FeatureId filter.
FilterFeatureId(java.util.ArrayList featureIds)
          Creates a FeatureId filter using an ArrayList of feature ID strings.
FilterFeatureId(java.lang.String featureId)
          Creates a FeatureId filter with a single entry.
 
Method Summary
 void addFeatureId(java.lang.String featureId)
          Adds an entry to the feature ID list.
 FilterAnd and(Filter anotherFilter)
          Combines two filters in an And element.
 int getFilterType()
          Gets an enumerated value indicating the type of filter this is.
 java.lang.String getKvpRequestString()
          Returns the FILTER= string to request features using this filter.
 java.lang.String getKvpRequestString(boolean useOgcNamespaces)
          Returns the FILTER= string to request features using this filter.
 java.lang.String getXmlRequestString()
          Returns the XML WFS request representing this filter.
 java.lang.String getXmlRequestString(boolean useOgcNamespaces)
          Returns the XML WFS request representing this filter.
 Filter not()
          This method has no effect for this type of filter.
 FilterOr or(Filter anotherFilter)
          Combines two filters in an Or element.
 java.lang.String toString()
          Displays this object as a text string.
 java.lang.String toString(boolean useOgcNamespaces)
          Displays this object as a text string.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

FilterFeatureId

public FilterFeatureId()
Creates a new empty FeatureId filter.


FilterFeatureId

public FilterFeatureId(java.lang.String featureId)
Creates a FeatureId filter with a single entry.

Parameters:
featureId - A feature ID string.

FilterFeatureId

public FilterFeatureId(java.util.ArrayList featureIds)
Creates a FeatureId filter using an ArrayList of feature ID strings.

Parameters:
featureIds - An array list of feature ID strings.
Method Detail

addFeatureId

public void addFeatureId(java.lang.String featureId)
Adds an entry to the feature ID list.

Parameters:
featureId - A feature ID string.

and

public FilterAnd and(Filter anotherFilter)
Combines two filters in an And element. Don't use this method if one of the objects is FilterBBOX or FilterFeatureId.

Specified by:
and in interface Filter
Returns:
The FilterAnd object combining the filters.

or

public FilterOr or(Filter anotherFilter)
Combines two filters in an Or element. Don't use this method if one of the objects is FilterBBOX or FilterFeatureId.

Specified by:
or in interface Filter
Returns:
The FilterOr object combining the filters.

not

public Filter not()
This method has no effect for this type of filter.

Specified by:
not in interface Filter
Returns:
The unchanged filter.

toString

public java.lang.String toString()
Displays this object as a text string.

Specified by:
toString in interface Filter
Returns:
The object as a text string.

toString

public java.lang.String toString(boolean useOgcNamespaces)
Displays this object as a text string.

Specified by:
toString in interface Filter
Parameters:
useOgcNamespaces - True if the string should contain OGC namespaces.
Returns:
The object as a text string.

getKvpRequestString

public java.lang.String getKvpRequestString()
Returns the FILTER= string to request features using this filter.

Specified by:
getKvpRequestString in interface Filter
Returns:
The FILTER= string to request features using this filter.

getKvpRequestString

public java.lang.String getKvpRequestString(boolean useOgcNamespaces)
Returns the FILTER= string to request features using this filter.

Specified by:
getKvpRequestString in interface Filter
Returns:
The FILTER= string to request features using this filter.

getXmlRequestString

public java.lang.String getXmlRequestString()
Returns the XML WFS request representing this filter.

Specified by:
getXmlRequestString in interface Filter
Returns:
The XML WFS request string.

getXmlRequestString

public java.lang.String getXmlRequestString(boolean useOgcNamespaces)
Returns the XML WFS request representing this filter.

Returns:
The XML WFS request string.

getFilterType

public int getFilterType()
Gets an enumerated value indicating the type of filter this is.

Specified by:
getFilterType in interface Filter
Returns:
The filter type;


Internet Mapping Framework for OpenGIS Java Object Model API (v1.3.007)
Copyright © 2005 Moxi Media Inc. and Province of British Columbia. All Rights Reserved.