| java.lang.Object
 org.geoserver.wfs.xml.NameSpaceTranslator
All known Subclasses: org.geoserver.wfs.xml.GMLSchemaTranslator, org.geoserver.wfs.xml.XMLSchemaTranslator,
| NameSpaceTranslator | | abstract public class NameSpaceTranslator (Code) | | NameSpaceTranslator purpose.
Helps perform translation between element names, definition names
and their java types for a particular namespace and namespace prefix.
Each name space translator should contain a list of name space
elements for their particular prefix. This loading should not be
completed lazily to avoid performance lags at run time. When ever
posible constants should alos be used for performance purposes.
USE:
NameSpaceTranslator nst = NameSpaceTranslatorFactor.getInstance().getNameSpaceTranslator("xs");
Class cls = nst.getElement("string").getJavaClass();
...
Object obj // contains some data, what can it be represented as?
String elementName = ((NameSpaceElement)nst.getElements(obj).toArray()[0]).getTypeRefName();
author:
dzwiers, Refractions Research, Inc.
author:
$Author: dmzwiers $ (last modification)
version:
$Id: NameSpaceTranslator.java 6413 2007-03-30 20:44:08Z saul.farber $ |
| Method Summary | |
| public Set | getAssociatedTypes(Class type)
Retrive all elements that can be used with the provided type.
Looks for Elements who's Class objects, or the parents of the
Class object are compatible with this class object.
Parameters:
type - Class the class to attempt to find related elements for. | | public Set | getAssociatedTypes(String type)
Looks for Elements who's name is the same or a super set of this name.
(ie. | | public NameSpaceElement | getDefaultElement(Class type)
Gets the default element for the class type passed in. | | public NameSpaceElement | getElement(String name)
Gets an element definition by name. | | public NameSpaceElement | getElement(Class type, String name)
Gets an element definition by name. | | abstract public Set | getElements()
getElements purpose. | | public Set | getElements(Class type)
getElements purpose. | | abstract public String | getNameSpace()
getNameSpace purpose.
Returns the current namespace. | | final public String | getPrefix()
getPrefix purpose. | | public boolean | isValidDefinition(String definition)
isValidDefinition purpose.
checks to see if the definition provided is found in the list of
elements for this namespace.
Parameters:
definition - The definition name to check for, may be either definition or prefix:definition. | | public boolean | isValidTypeRef(String type)
isValidTypeRef purpose.
checks to see if the reference provided is found in the list of
elements for this namespace.
Parameters:
definition - The reference name to check for, may be either reference or prefix:reference. |
| NameSpaceTranslator | | public NameSpaceTranslator(String prefix)(Code) | | NameSpaceTranslator constructor.
Creates an instance of this translator for the given prefix.
Parameters:
prefix - The prefix for which this tranlator will tranlate.A null prefix will affect the NameSpaceElements returned by theaccess methods.
See Also: NameSpaceElement(String) |
| getAssociatedTypes | | public Set getAssociatedTypes(Class type)(Code) | | Retrive all elements that can be used with the provided type.
Looks for Elements who's Class objects, or the parents of the
Class object are compatible with this class object.
Parameters:
type - Class the class to attempt to find related elements for. Set a set of associated NameSpaceElements |
| getAssociatedTypes | | public Set getAssociatedTypes(String type)(Code) | | Looks for Elements who's name is the same or a super set of this name.
(ie. name.indexOf(type)!=-1)
Parameters:
type - String the class to attempt to find related elements for. Set a set of associated NameSpaceElements
See Also: String.indexOf(String) |
| getDefaultElement | | public NameSpaceElement getDefaultElement(Class type)(Code) | | Gets the default element for the class type passed in. Note that this
is a bit hacky, as it doesn't not depend on a real namespace map, but
on careful assignment of the NamespaceElements, so that each class only
has one that returns true for isDefault(). Sorry for the hackiness,
I need to get a release out.
|
| getElement | | public NameSpaceElement getElement(String name)(Code) | | Gets an element definition by name.
Parameters:
name - The name of the element definition NameSpaceElement |
| getElement | | public NameSpaceElement getElement(Class type, String name)(Code) | | Gets an element definition by name.
Parameters:
name - The name of the element definition NameSpaceElement |
| getElements | | abstract public Set getElements()(Code) | | getElements purpose.
returns the set of elements.
Set |
| getElements | | public Set getElements(Class type)(Code) | | getElements purpose.
Returns a set of all elements with the exact class specified.
Parameters:
type - Class the class of elements to get Set |
| getNameSpace | | abstract public String getNameSpace()(Code) | | getNameSpace purpose.
Returns the current namespace. Should be implemented as a constant.
String |
| getPrefix | | final public String getPrefix()(Code) | | getPrefix purpose.
Returns the prefix that this namespace represents.
String the prefix, null if it does not exist |
| isValidDefinition | | public boolean isValidDefinition(String definition)(Code) | | isValidDefinition purpose.
checks to see if the definition provided is found in the list of
elements for this namespace.
Parameters:
definition - The definition name to check for, may be either definition or prefix:definition. true when found, false otherwise. |
| isValidTypeRef | | public boolean isValidTypeRef(String type)(Code) | | isValidTypeRef purpose.
checks to see if the reference provided is found in the list of
elements for this namespace.
Parameters:
definition - The reference name to check for, may be either reference or prefix:reference. true when found, false otherwise. |
|
|