org.vfny.geoserver.global.xml.NameSpaceElement Maven / Gradle / Ivy
/*
* Created on Feb 5, 2004
*
* To change the template for this generated file go to
* Window - Preferences - Java - Code Generation - Code and Comments
*/
package org.vfny.geoserver.global.xml;
/**
* NameSpaceElement purpose.
*
* NameSpaceElement sub classes will represent a particular element
* found within a particular namespace. Most of the methods below
* should return constants to improve performance.
*
*
* @author dzwiers, Refractions Research, Inc.
* @author $Author: dmzwiers $ (last modification)
* @version $Id: NameSpaceElement.java 6177 2007-02-19 10:11:27Z aaime $
*/
public abstract class NameSpaceElement {
/** the namespace prefix to use for qualification*/
protected final String prefix;
/**
* NameSpaceElement constructor.
*
* Creates an instance of this NameSpaceElement.
*
*
* The prefix is to be used for the qualification routines.
* If the prefix passed is null, then qualified names will be
* null unless they have a prefix specified.
*
* @param prefix The prefix to use for qualification.
*/
public NameSpaceElement(String prefix) {
this.prefix = prefix;
}
/**
* NameSpaceElement constructor.
*
* Creates an instance of this NameSpaceElement.
*
*
* The prefix is to be used for the qualification routines is set to null.
* the qualified names of the elements will be null
*
*/
public NameSpaceElement() {
this.prefix = null;
}
/**
* getTypeDefName purpose.
*
* This will return the name of the definition of the element.
* This method is useful when defining a new type and wish to
* extend an existing defined type, such as
* gml:AbstractFeatureType.
*
*
*
*
*
*
*
*
*
*
*
*
*
* @return The type def. name, for the above example AbstractFeatureType.
*/
public abstract String getTypeDefName();
/**
* getTypeDefName purpose.
*
* This will return the name of the element.
* This method is useful when defining a new element and wish to
* extend an existing element, such as xs:string.
*
*
*
*
*
* @return The element name, for the above example string or lineStringProperty.
*/
public abstract String getTypeRefName();
/**
* getQualifiedTypeDefName purpose.
*
* Returns a qualified type definition name prefix:definition name.
*
* @return the name if the default prefix is non null, null otherwise
* @see getTypeDefName()
*/
public abstract String getQualifiedTypeDefName();
/**
* getQualifiedTypeRefName purpose.
*
* Returns a qualified type reference name prefix:reference name.
*
* @return the name if the default prefix is non null, null otherwise
* @see getTypeRefName()
*/
public abstract String getQualifiedTypeRefName();
/**
* getQualifiedTypeDefName purpose.
*
* Returns a qualified type definition name prefix:definition name with the specified prefix.
*
* @param prefix The prefix to use for qualification.
* @return the name if either the specified or default prefix is non null, null otherwise
* @see getTypeDefName()
*/
public abstract String getQualifiedTypeDefName(String prefix);
/**
* getQualifiedTypeRefName purpose.
*
* Returns a qualified type reference name prefix:reference name with the specified prefix.
*
* @param prefix The prefix to use for qualification.
* @return the name if either the specified or default prefix is non null, null otherwise
* @see getTypeRefName()
*/
public abstract String getQualifiedTypeRefName(String prefix);
/**
* getJavaClass purpose.
*
* Returns an instance of the Class object which would best represent this element.
*
*
* for example an element of type xs:int would return Integer.class.
*
* @return Class instance of the Class object which would best represent this element.
*/
public abstract Class getJavaClass();
/**
* This is a bit of a hack, so that GeoServer can generate with the best
* (default) xml mappings for each Java class. This should be implemented
* the other way around, with a nice lookup table to get the one and only
* default. But this is far easier to implement, as we just add this
* method set to true for the namespace element classes we like best. If
* for some reason we set two NSE's that map to the same java class to true
* then things will behave randomly, which is why this is a bit of a hack.
* Apologies, it's late, and I need to finish my docs.
*/
public boolean isDefault() {
return false;
}
/* (non-Javadoc)
* @see java.lang.Object#toString()
*/
public String toString() {
return getQualifiedTypeDefName(prefix);
}
public abstract boolean isAbstract();
}