| java.lang.Object
 org.vfny.geoserver.global.GlobalLayerSupertype
org.vfny.geoserver.global.FeatureTypeInfo
All known Subclasses: org.vfny.geoserver.global.TemporaryFeatureTypeInfo,
| FeatureTypeInfo | | public class FeatureTypeInfo extends GlobalLayerSupertype (Code) | | Represents a FeatureTypeInfo, its user config and autodefined information.
This class implements
org.geotools.catalog.Service interface as a
link to a catalog.
author:
Gabriel Rold?n
author:
Chris Holmes
author:
dzwiers
author:
Charles Kolbowicz
version:
$Id: FeatureTypeInfo.java 8391 2008-02-13 16:44:23Z aaime $ |
| Method Summary | |
| public synchronized AttributeTypeInfo | AttributeTypeMetaData(String attributeName)
Implement AttributeTypeMetaData. | | public boolean | containsMetaData(String key)
Implement containsMetaData. | | public String | getAbstract()
Get abstract (description) of FeatureType. | | protected String | getAttribute(Element elem, String attName, boolean mandatory)
getAttribute purpose.
XLM helper method.
Parameters:
elem - The element to work on.
Parameters:
attName - The attribute name to find
Parameters:
mandatory - true is an exception is be thrown when the attr is notfound. | | public List | getAttributeNames()
FeatureType attributes names as a List.
Convience method for accessing attribute names as a Collection. | | public List | getAttributes()
Returns a list of the attributeTypeInfo objects that make up this
FeatureType. | | public Envelope | getBoundingBox()
Returns the FeatureType's envelope in its native CRS (or user
declared CRS, if any). | | public String | getCacheMaxAge()
This value is added the headers of generated maps, marking them as being both
"cache-able" and designating the time for which they are to remain valid. | | public DataStoreInfo | getDataStoreInfo()
getDataStore purpose.
gets the string of the path to the schema file. | | public DataStoreInfo | getDataStoreMetaData()
Implement getDataStoreMetaData. | | public CoordinateReferenceSystem | getDeclaredCRS()
| | GeometryAttributeType | getDefaultGeometry()
| | public Style | getDefaultStyle()
By now just return the default style to be able to declare it in
WMS capabilities, but all this stuff needs to be revisited since it seems
currently there is no way of retrieving all the styles declared for
a given FeatureType. | | public Filter | getDefinitionQuery()
getDefinitionQuery purpose. | | public String | getDirName()
| | public FeatureSource | getFeatureSource()
getFeatureSource purpose. | | public FeatureSource | getFeatureSource(boolean skipReproject)
If this layers has been setup to reproject data, skipReproject = true will
disable reprojection. | | public FeatureType | getFeatureType()
Access real geotools2 FeatureType. | | public List | getKeywords()
Keywords describing content of FeatureType. | | public Envelope | getLatLongBoundingBox()
getLatLongBoundingBox purpose. | | public LegendURL | getLegendURL()
getLegendURL purpose. | | public int | getMaxFeatures()
| | public Object | getMetaData(String key)
Implement getMetaData. | | public List | getMetadataLinks()
Metadata links providing metadata access for FeatureTypes. | | public String | getName()
Complete xml name (namespace:element> for this FeatureType. | | public NameSpaceInfo | getNameSpace()
Gets the namespace for this featureType.
This isn't _really_ necessary,
but I'm putting it in in case we change namespaces, letting
FeatureTypes set their own namespaces instead of being dependant on
datasources. | | public CoordinateReferenceSystem | getNativeCRS()
| | public String | getNativeTypeName()
Access the name of this SimpleFeatureType. | | public int | getNumDecimals()
getNumDecimals purpose. | | public String | getPrefix()
Returns the XML prefix used for GML output of this FeatureType. | | public String | getSRS()
getSRS purpose. | | public String | getSchemaBase()
getSchemaName purpose. | | public File | getSchemaFile()
Gets the schema.xml file associated with this FeatureType. | | public String | getSchemaName()
A valid schema name for this FeatureType. | | public ArrayList | getStyles()
| | public String | getTitle()
getTitle purpose. | | public String | getTypeName()
Access the name of this FeatureType. | | public String | getWmsPath()
| | public boolean | isCachingEnabled()
| | public boolean | isEnabled()
Indicates if this FeatureTypeInfo is enabled. | | public boolean | isGeometryless()
| | public void | putMetaData(String key, Object value)
Implement putMetaData. | | public void | setCacheMaxAge(String cacheMaxAge)
| | public void | setCachingEnabled(boolean cachingEnabled)
| | public void | setMaxFeatures(int maxFeatures)
| | public void | setSchemaBase(String string)
setSchemaName purpose. | | public void | setSchemaName(String string)
setSchemaName purpose. | | public void | setWmsPath(String wmsPath)
| | public Object | toDTO()
toDTO purpose.
This method is package visible only, and returns a reference to the
GeoServerDTO. |
| FORCE | | public static int FORCE(Code) | | Force declared SRS
|
| LEAVE | | public static int LEAVE(Code) | | Don't do anything, declared and actual are equal
|
| REPROJECT | | public static int REPROJECT(Code) | | Reproject to declared SRS
|
| typeName | | String typeName(Code) | | typeName as defined by gt2 DataStore
|
| FeatureTypeInfo | | public FeatureTypeInfo()(Code) | | dont use this unless you know what you're doing. its for TemporaryFeatureTypeInfo.
|
| FeatureTypeInfo | | public FeatureTypeInfo(FeatureTypeInfoDTO dto, Data data) throws ConfigurationException(Code) | | FeatureTypeInfo constructor.
Generates a new object from the data provided.
Parameters:
dto - FeatureTypeInfoDTO The data to populate this class with.
Parameters:
data - Data a reference for future use to get at DataStoreInfoinstances
throws:
ConfigurationException - |
| AttributeTypeMetaData | | public synchronized AttributeTypeInfo AttributeTypeMetaData(String attributeName)(Code) | | Implement AttributeTypeMetaData.
Description ...
Parameters:
attributeName -
See Also: org.geotools.data.FeatureTypeMetaData.AttributeTypeMetaData(java.lang.String) |
| containsMetaData | | public boolean containsMetaData(String key)(Code) | | Implement containsMetaData.
Parameters:
key -
See Also: org.geotools.data.MetaData.containsMetaData(java.lang.String) |
| getAbstract | | public String getAbstract()(Code) | | Get abstract (description) of FeatureType.
Short description of FeatureType |
| getAttribute | | protected String getAttribute(Element elem, String attName, boolean mandatory) throws ConfigurationException(Code) | | getAttribute purpose.
XLM helper method.
Parameters:
elem - The element to work on.
Parameters:
attName - The attribute name to find
Parameters:
mandatory - true is an exception is be thrown when the attr is notfound. String the Attr value
throws:
ConfigurationException - thrown when an error occurs. |
| getAttributeNames | | public List getAttributeNames()(Code) | | FeatureType attributes names as a List.
Convience method for accessing attribute names as a Collection. You may
use the names for AttributeTypeMetaData lookup or with the schema for
XPATH queries.
List of attribute names
See Also: org.geotools.data.FeatureTypeMetaData.getAttributeNames |
| getAttributes | | public List getAttributes()(Code) | | Returns a list of the attributeTypeInfo objects that make up this
FeatureType.
list of attributeTypeInfo objects. |
| getBoundingBox | | public Envelope getBoundingBox() throws IOException(Code) | | Returns the FeatureType's envelope in its native CRS (or user
declared CRS, if any).
Note the Envelope is cached in order to avoid a potential
performance penalty every time this value is requires (for example,
at every GetCapabilities request)
Envelope of the feature source bounds.
throws:
IOException - when an error occurs |
| getCacheMaxAge | | public String getCacheMaxAge()(Code) | | This value is added the headers of generated maps, marking them as being both
"cache-able" and designating the time for which they are to remain valid.
The specific header added is "Cache-Control: max-age="
a string representing the number of seconds to be added to the "Cache-Control: max-age=" header |
| getDataStoreInfo | | public DataStoreInfo getDataStoreInfo()(Code) | | getDataStore purpose.
gets the string of the path to the schema file. This is set during
feature reading, the schema file should be in the same folder as the
feature type info, with the name schema.xml. This function does not
guarantee that the schema file actually exists, it just gives the
location where it _should_ be located.
DataStoreInfo the requested DataStoreInfo if it was found.
See Also: Data.getDataStoreInfo(String) |
| getDataStoreMetaData | | public DataStoreInfo getDataStoreMetaData()(Code) | | Implement getDataStoreMetaData.
See Also: org.geotools.data.FeatureTypeMetaData.getDataStoreMetaData |
| getDeclaredCRS | | public CoordinateReferenceSystem getDeclaredCRS()(Code) | | Returns the declared CRS, that is, the CRS specified in the feature type
editor form
|
| getDefaultGeometry | | GeometryAttributeType getDefaultGeometry() throws IOException(Code) | | Returns the default geometry for this feature type
throws:
IOException - if the layer is not properly configured |
| getDefaultStyle | | public Style getDefaultStyle()(Code) | | By now just return the default style to be able to declare it in
WMS capabilities, but all this stuff needs to be revisited since it seems
currently there is no way of retrieving all the styles declared for
a given FeatureType.
the default Style for the FeatureType |
| getDefinitionQuery | | public Filter getDefinitionQuery()(Code) | | getDefinitionQuery purpose.
Returns the definition query for this feature source
Filter the definition query |
| getFeatureSource | | public FeatureSource getFeatureSource() throws IOException(Code) | | getFeatureSource purpose.
Returns a real FeatureSource.
FeatureSource the feature source represented by this info class
throws:
IOException - when an error occurs. |
| getFeatureSource | | public FeatureSource getFeatureSource(boolean skipReproject) throws IOException(Code) | | If this layers has been setup to reproject data, skipReproject = true will
disable reprojection. This method is build especially for the rendering subsystem
that should be able to perform a full reprojection on its own, and do generalization
before reprojection (thus avoid to reproject all of the original coordinates)
|
| getFeatureType | | public FeatureType getFeatureType() throws IOException(Code) | | Access real geotools2 FeatureType.
Schema information.
throws:
IOException -
See Also: org.geotools.data.FeatureTypeMetaData.getFeatureType |
| getKeywords | | public List getKeywords()(Code) | | Keywords describing content of FeatureType.
Keywords are often used by Search engines or Catalog services.
List the FeatureTypeInfo keywords |
| getLatLongBoundingBox | | public Envelope getLatLongBoundingBox() throws IOException(Code) | | getLatLongBoundingBox purpose.
The feature source lat/long bounds.
Envelope the feature source lat/long bounds.
throws:
IOException - when an error occurs |
| getLegendURL | | public LegendURL getLegendURL()(Code) | | getLegendURL purpose.
returns the FeatureTypeInfo legendURL
String the FeatureTypeInfo legendURL |
| getMaxFeatures | | public int getMaxFeatures()(Code) | | Returns the maximum number of features to be served by WFS GetFeature for this feature
type (or 0 for no limit)
|
| getMetaData | | public Object getMetaData(String key)(Code) | | Implement getMetaData.
Parameters:
key -
See Also: org.geotools.data.MetaData.getMetaData(java.lang.String) |
| getMetadataLinks | | public List getMetadataLinks()(Code) | | Metadata links providing metadata access for FeatureTypes.
List the FeatureTypeInfo metadata links |
| getName | | public String getName()(Code) | | Complete xml name (namespace:element> for this FeatureType.
This is the full type name with namespace prefix.
String the FeatureTypeInfo name - should be unique for theparent Data instance. |
| getNameSpace | | public NameSpaceInfo getNameSpace()(Code) | | Gets the namespace for this featureType.
This isn't _really_ necessary,
but I'm putting it in in case we change namespaces, letting
FeatureTypes set their own namespaces instead of being dependant on
datasources. This method will allow us to make that change more easily
in the future.
NameSpaceInfo the namespace specified for the specifiedDataStoreInfo (by ID)
throws:
IllegalStateException - THrown when disabled. |
| getNativeTypeName | | public String getNativeTypeName()(Code) | | Access the name of this SimpleFeatureType.
This is the typeName as provided by the gt2 datastore, even when an alias
is set
String getName()
See Also: org.geotools.data.FeatureTypeMetaData.getTypeName |
| getNumDecimals | | public int getNumDecimals()(Code) | | getNumDecimals purpose.
The default number of decimals allowed in the data.
int the default number of decimals allowed in the data. |
| getPrefix | | public String getPrefix()(Code) | | Returns the XML prefix used for GML output of this FeatureType.
Returns the namespace prefix for this FeatureTypeInfo.
String the namespace prefix. |
| getSRS | | public String getSRS()(Code) | | getSRS purpose.
Proprietary identifier number
int the SRS number. |
| getSchemaBase | | public String getSchemaBase()(Code) | | getSchemaName purpose.
Description ...
|
| getSchemaFile | | public File getSchemaFile()(Code) | | Gets the schema.xml file associated with this FeatureType. This is set
during the reading of configuration, it is not persisted as an element
of the FeatureTypeInfoDTO, since it is just whether the schema.xml file
was persisted, and its location. If there is no schema.xml file then
this method will return a File object with the location where the schema
file would be located, but the file will return false for exists().
|
| getSchemaName | | public String getSchemaName()(Code) | | A valid schema name for this FeatureType.
schemaName if provided or typeName+"_Type" |
| getTitle | | public String getTitle()(Code) | | getTitle purpose.
returns the FeatureTypeInfo title
String the FeatureTypeInfo title |
| getTypeName | | public String getTypeName()(Code) | | Access the name of this FeatureType.
This is the typeName as provided by the gt2 datastore, unless an alias
is set, in that case the alias is returned
String getName()
See Also: org.geotools.data.FeatureTypeMetaData.getTypeName |
| isCachingEnabled | | public boolean isCachingEnabled()(Code) | | Should we add the cache-control: max-age header to maps containing this layer?
true if we should, false if we should omit the header |
| isEnabled | | public boolean isEnabled()(Code) | | Indicates if this FeatureTypeInfo is enabled. For now just gets whether
the backing datastore is enabled.
true if this FeatureTypeInfo is enabled. |
| isGeometryless | | public boolean isGeometryless() throws IOException(Code) | | If true, the layer does not have a default geometry
throws:
IOException - |
| putMetaData | | public void putMetaData(String key, Object value)(Code) | | Implement putMetaData.
Parameters:
key -
Parameters:
value -
See Also: org.geotools.data.MetaData.putMetaData(java.lang.Stringjava.lang.Object) |
| setCacheMaxAge | | public void setCacheMaxAge(String cacheMaxAge)(Code) | |
Parameters:
cacheMaxAge - a string representing the number of seconds to be added to the "Cache-Control: max-age=" header |
| setCachingEnabled | | public void setCachingEnabled(boolean cachingEnabled)(Code) | | Sets whether we should add the cache-control: max-age header to maps containing this layer
Parameters:
cachingEnabled - true if we should add the header, false if we should omit the header |
| setMaxFeatures | | public void setMaxFeatures(int maxFeatures)(Code) | | |
| setSchemaBase | | public void setSchemaBase(String string)(Code) | | setSchemaName purpose.
Description ...
Parameters:
string - |
| setSchemaName | | public void setSchemaName(String string)(Code) | | setSchemaName purpose.
Description ...
Parameters:
string - |
| toDTO | | public Object toDTO()(Code) | | toDTO purpose.
This method is package visible only, and returns a reference to the
GeoServerDTO. This method is unsafe, and should only be used with
extreme caution.
FeatureTypeInfoDTO the generated object |
| Fields inherited from org.vfny.geoserver.global.GlobalLayerSupertype | final protected static Logger LOGGER(Code)(Java Doc)
|
| Methods inherited from org.vfny.geoserver.global.GlobalLayerSupertype | public static String get(Map map, String key)(Code)(Java Doc)
public static File get(Map map, String key, File defaultFile)(Code)(Java Doc)
public static String get(Map map, String key, String defaultValue)(Code)(Java Doc)
public static List get(Map map, String key, List defaultList)(Code)(Java Doc)
public static Map get(Map map, String key, Map defaultMap)(Code)(Java Doc)
public static int get(Map map, String key, int defaultValue)(Code)(Java Doc)
public static boolean get(Map map, String key, boolean defaultValue)(Code)(Java Doc)
public static Charset get(Map map, String key, Charset defaultCharSet)(Code)(Java Doc)
public static Level get(Map map, String key, Level defaultLevel)(Code)(Java Doc)
public static URL get(Map map, String key, URL defaultUrl)(Code)(Java Doc)
public static Class get(Map map, String key, Class defaultType)(Code)(Java Doc)
protected String notNull(String s)(Code)(Java Doc)
abstract Object toDTO()(Code)(Java Doc)
|
|
|