org.vfny.geoserver.global.dto
Class FeatureTypeInfoDTO

java.lang.Object
  extended byorg.vfny.geoserver.global.dto.FeatureTypeInfoDTO
All Implemented Interfaces:
java.lang.Cloneable, DataTransferObject

public final class FeatureTypeInfoDTO
extends java.lang.Object
implements DataTransferObject

Data Transfer Object used for GeoServer FeatureTypeInfo information.

FeatureTypeInfo is used because FeatureType is already used to represent schema information in GeoTools2.

Data Transfer object are used to communicate between the GeoServer application and its configuration and persistent layers. As such the class is final - to allow for its future use as an on-the-wire message.

Example:
 FeatureTypeInfoDTO ftiDto = new FeatureTypeInfoDTO();
 ftiDto.setName("My Feature Type");
 ftiDto.setTitle("The Best Feature Type");
 ftiDto.setSRS(23769);
 ftiDto.setDataStoreId("myDataStore");
 


Constructor Summary
FeatureTypeInfoDTO()
          FeatureTypeInfo constructor.
FeatureTypeInfoDTO(FeatureTypeInfoDTO dto)
          FeatureTypeInfo constructor.
 
Method Summary
 boolean addKeyword(java.lang.String key)
          setKeywords purpose.
 java.lang.Object clone()
          Implement clone as a deep copy.
 boolean equals(java.lang.Object obj)
          Implement equals.
 java.lang.String getAbstract()
          Short description of FeatureType.
 java.lang.String getDataStoreId()
          Identifier of DataStore used to create FeatureType.
 java.lang.String getDefaultStyle()
          getDefaultStyle purpose.
 org.geotools.filter.Filter getDefinitionQuery()
          getDefinitionQuery purpose.
 java.lang.String getDirName()
          getDirName purpose.
 java.lang.String getKey()
          Convience method for dataStoreId.typeName.
 java.util.List getKeywords()
          List of keywords (limitied to text).
 com.vividsolutions.jts.geom.Envelope getLatLongBBox()
          The extent of this FeatureType.
 java.lang.String getName()
          Name of featureType, must match typeName provided by DataStore.
 int getNumDecimals()
          getNumDecimals purpose.
 java.util.List getSchemaAttributes()
          getSchema purpose.
 java.lang.String getSchemaBase()
          getSchemaBase purpose.
 java.lang.String getSchemaName()
          getSchemaName purpose.
 int getSRS()
          Spatial Reference System for FeatureType.
 java.lang.String getTitle()
          Title used to identify FeatureType to user.
 int hashCode()
          Implement hashCode.
 boolean removeKeyword(java.lang.String key)
          setKeywords purpose.
 void setAbstract(java.lang.String string)
          setAbstract purpose.
 void setDataStoreId(java.lang.String store)
          setDataStore purpose.
 void setDefaultStyle(java.lang.String string)
          setDefaultStyle purpose.
 void setDefinitionQuery(org.geotools.filter.Filter filter)
          setDefinitionQuery purpose.
 void setDirName(java.lang.String string)
          setDirName purpose.
 void setKeywords(java.util.List list)
          setKeywords purpose.
 void setLatLongBBox(com.vividsolutions.jts.geom.Envelope envelope)
          setLatLongBBox purpose.
 void setName(java.lang.String string)
          setName purpose.
 void setNumDecimals(int i)
          setNumDecimals purpose.
 void setSchemaAttributes(java.util.List schemaElements)
          setSchema purpose.
 void setSchemaBase(java.lang.String string)
          setSchemaBase purpose.
 void setSchemaName(java.lang.String string)
          setSchemaName purpose.
 void setSRS(int i)
          setSRS purpose.
 void setTitle(java.lang.String string)
          setTitle purpose.
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FeatureTypeInfoDTO

public FeatureTypeInfoDTO()
FeatureTypeInfo constructor.

does nothing


FeatureTypeInfoDTO

public FeatureTypeInfoDTO(FeatureTypeInfoDTO dto)
FeatureTypeInfo constructor.

Creates a copy of the FeatureTypeInfo provided. If the FeatureTypeInfo provided is null then default values are used. All the data structures are cloned.

Parameters:
dto - The featuretype to copy.
Throws:
java.lang.NullPointerException - DOCUMENT ME!
Method Detail

clone

public java.lang.Object clone()
Implement clone as a deep copy.

Specified by:
clone in interface DataTransferObject
Returns:
A copy of this FeatureTypeInfo
See Also:
Object.clone()

equals

public boolean equals(java.lang.Object obj)
Implement equals.

recursively tests to determine if the object passed in is a copy of this object.

Specified by:
equals in interface DataTransferObject
Parameters:
obj - The FeatureTypeInfo object to test.
Returns:
true when the object passed is the same as this object.
See Also:
Object.equals(java.lang.Object)

hashCode

public int hashCode()
Implement hashCode.

Specified by:
hashCode in interface DataTransferObject
Returns:
Service hashcode or 0
See Also:
Object.hashCode()

getAbstract

public java.lang.String getAbstract()
Short description of FeatureType.

Returns:
Description of FeatureType

getDataStoreId

public java.lang.String getDataStoreId()
Identifier of DataStore used to create FeatureType.

Returns:
DataStore identifier

getKeywords

public java.util.List getKeywords()
List of keywords (limitied to text).

Returns:
List of Keywords about this FeatureType

getKey

public java.lang.String getKey()
Convience method for dataStoreId.typeName.

This key may be used to store this FeatureType in a Map for later.

Returns:
dataStoreId.typeName

getLatLongBBox

public com.vividsolutions.jts.geom.Envelope getLatLongBBox()
The extent of this FeatureType.

Extent is measured against the tranditional LatLong coordinate system.

Returns:
Envelope of FeatureType

getName

public java.lang.String getName()
Name of featureType, must match typeName provided by DataStore.

Returns:
typeName of FeatureType

getSRS

public int getSRS()
Spatial Reference System for FeatureType.

Makes use of the standard EPSG codes?

Returns:
WPSG Spatial Reference System for FeatureType

getTitle

public java.lang.String getTitle()
Title used to identify FeatureType to user.

Returns:
FeatureType title

setAbstract

public void setAbstract(java.lang.String string)
setAbstract purpose.

Description ...

Parameters:
string -

setDataStoreId

public void setDataStoreId(java.lang.String store)
setDataStore purpose.

Description ...

Parameters:
store -

setKeywords

public void setKeywords(java.util.List list)
setKeywords purpose.

Description ...

Parameters:
list -

addKeyword

public boolean addKeyword(java.lang.String key)
setKeywords purpose.

Description ...

Parameters:
key -
Returns:
boolean true when added.

removeKeyword

public boolean removeKeyword(java.lang.String key)
setKeywords purpose.

Description ...

Parameters:
key -
Returns:
true whwn removed

setLatLongBBox

public void setLatLongBBox(com.vividsolutions.jts.geom.Envelope envelope)
setLatLongBBox purpose.

Description ...

Parameters:
envelope -

setName

public void setName(java.lang.String string)
setName purpose.

Description ...

Parameters:
string -

setSRS

public void setSRS(int i)
setSRS purpose.

Description ...

Parameters:
i -

setTitle

public void setTitle(java.lang.String string)
setTitle purpose.

Description ...

Parameters:
string -

getNumDecimals

public int getNumDecimals()
getNumDecimals purpose.

Description ...

Returns:

setNumDecimals

public void setNumDecimals(int i)
setNumDecimals purpose.

Description ...

Parameters:
i -

getDefinitionQuery

public org.geotools.filter.Filter getDefinitionQuery()
getDefinitionQuery purpose.

Description ...

Returns:

setDefinitionQuery

public void setDefinitionQuery(org.geotools.filter.Filter filter)
setDefinitionQuery purpose.

Description ...

Parameters:
filter -

getDefaultStyle

public java.lang.String getDefaultStyle()
getDefaultStyle purpose.

Description ...

Returns:

setDefaultStyle

public void setDefaultStyle(java.lang.String string)
setDefaultStyle purpose.

Description ...

Parameters:
string -

getSchemaAttributes

public java.util.List getSchemaAttributes()
getSchema purpose.

Returns An ordered list of AttributeTypeInfoDTOs

Returns:
An ordered list of AttributeTypeInfoDTOs

setSchemaAttributes

public void setSchemaAttributes(java.util.List schemaElements)
setSchema purpose.

Stores a list of AttributeTypeInfoDTOs.

Parameters:
schemaElements - An ordered list of AttributeTypeInfoDTOs

getDirName

public java.lang.String getDirName()
getDirName purpose.

Description ...

Returns:

setDirName

public void setDirName(java.lang.String string)
setDirName purpose.

Description ...

Parameters:
string -

getSchemaName

public java.lang.String getSchemaName()
getSchemaName purpose.

Description ...

Returns:

setSchemaName

public void setSchemaName(java.lang.String string)
setSchemaName purpose.

Description ...

Parameters:
string -

getSchemaBase

public java.lang.String getSchemaBase()
getSchemaBase purpose.

Description ...

Returns:

setSchemaBase

public void setSchemaBase(java.lang.String string)
setSchemaBase purpose.

Description ...

Parameters:
string -