| org.geotools.xml.schema.Schema
All known Subclasses: org.geotools.xml.filter.FilterSchema, org.geotools.xml.xLink.XLinkSchema, org.geotools.data.wms.xml.WMSSchema, org.geotools.xml.styling.sldSchema, org.geotools.xml.gml.GMLSchema, org.geotools.xml.wfs.WFSSchema, org.geotools.data.wms.xml.OGCSchema,
| Schema | | public interface Schema extends Factory(Code) | |
This Interface is intended to represent the public portion of an XML Schema.
By public portion, I mean the portion of the Schema which can be included
in an instance document, or imported into another Schema.
The distinction between the public portion of a XML Schema and the entire
XML Schema is or particular important when comparing, or printing two XML
Schemas. This interface does is intended to provide enough information to
re-create the original Schema (note the lack or annotations as an example).
This interface is however intended to provide functional semantic
equivalence. By this is mean that two XML Schemas represented using this
interface should have the same SET of declarations. There is no guarantee
that the Schema represented matches the original document with respect to
orderwithin the sets, except where order is explicitly defined (Sequence,
Choice).
This method must be inplemented within extensions: public static Schema
getInstance();. It will be used by the Schema factory to load the required
extensions into memory.
author:
dzwiers www.refractions.net |
| Field Summary | |
| final public static int | ALL
Used to denote byte masks representing either XML block attributes or
XML final attributes. | | final public static int | EXTENSION
Used to denote byte masks representing either XML block attributes or
XML final attributes. | | final public static int | NONE
Used to denote byte masks representing either XML block attributes or
XML final attributes. | | final public static int | RESTRICTION
Used to denote byte masks representing either XML block attributes or
XML final attributes. |
| Method Summary | |
| public AttributeGroup[] | getAttributeGroups()
This method is intended to provide a list of public AttributeGroups
defined by this Schema. | | public Attribute[] | getAttributes()
This method is intended to provide a list of public Attributes defined
by this Schema. | | public int | getBlockDefault()
This method returns the default block value associated with this schema
as a mask. | | public ComplexType[] | getComplexTypes()
This method is intended to provide a list of public ComplexTypes defined
by this Schema. | | public Element[] | getElements()
This method is intended to provide a list of public Elements defined by
this Schema. | | public int | getFinalDefault()
This method returns the default final value associated with this schema
as a mask. | | public Group[] | getGroups()
This method is intended to provide a list of public Groups defined by
this Schema. | | public String | getId()
This method is intended to provide the ID of this Schema. | | public Schema[] | getImports()
This method is intended to provide a list of public Imports defined by
this Schema. | | public String | getPrefix()
Gets the recommended prefix for this schema. | | public SimpleType[] | getSimpleTypes()
This method is intended to provide a list of public SimpleTypes defined
by this Schema. | | public URI | getTargetNamespace()
This returns the intended use name of the Schema (kinda like an ID, for
a better definition see the XML Schema Specification). | | public URI | getURI()
| | public String | getVersion()
This returns the Schema version ... | | public boolean | includesURI(URI uri)
This looks to see if the URI passed in is represented by this Schema. | | public boolean | isAttributeFormDefault()
Returns true when the Default Attribute Form is qualified, false
otherwise. | | public boolean | isElementFormDefault()
Returns true when the Default Element Form is qualified, false
otherwise. |
| ALL | | final public static int ALL(Code) | | Used to denote byte masks representing either XML block attributes or
XML final attributes.
|
| EXTENSION | | final public static int EXTENSION(Code) | | Used to denote byte masks representing either XML block attributes or
XML final attributes.
|
| NONE | | final public static int NONE(Code) | | Used to denote byte masks representing either XML block attributes or
XML final attributes.
|
| RESTRICTION | | final public static int RESTRICTION(Code) | | Used to denote byte masks representing either XML block attributes or
XML final attributes.
|
| getAttributeGroups | | public AttributeGroup[] getAttributeGroups()(Code) | |
This method is intended to provide a list of public AttributeGroups
defined by this Schema. The definition of 'public AttributeGroups'
should be interpreted as the set of AttributeGroups availiable when
creating an instance document, extending the schema, or importing the
schema.
AttributeGroup[]
See Also: AttributeGroup |
| getAttributes | | public Attribute[] getAttributes()(Code) | |
This method is intended to provide a list of public Attributes defined
by this Schema. The definition of 'public Attributes' should be
interpreted as the set of Attributes availiable when creating an
instance document, extending the schema, or importing the schema.
See Also: Attribute |
| getBlockDefault | | public int getBlockDefault()(Code) | |
This method returns the default block value associated with this schema
as a mask. The keys for the mask are represented as constants at the
head of this file. As defined in the XML Schema specification, element
and type blocks should only be extended to include this block if one is
not specified.
Block Mask |
| getComplexTypes | | public ComplexType[] getComplexTypes()(Code) | |
This method is intended to provide a list of public ComplexTypes defined
by this Schema. The definition of 'public ComplexTypes' should be
interpreted as the set of ComplexTypes availiable when creating an
instance document, extending the schema, or importing the schema.
See Also: ComplexType |
| getElements | | public Element[] getElements()(Code) | |
This method is intended to provide a list of public Elements defined by
this Schema. The definition of 'public Elements' should be interpreted
as the set of Elements availiable when creating an instance document,
extending the schema, or importing the schema.
See Also: Element |
| getFinalDefault | | public int getFinalDefault()(Code) | |
This method returns the default final value associated with this schema
as a mask. The keys for the mask are represented as constants at the
head of this file. As defined in the XML Schema specification, element
and type final values should only be extended to include this final
value if one is not specified.
Final Mask |
| getGroups | | public Group[] getGroups()(Code) | |
This method is intended to provide a list of public Groups defined by
this Schema. The definition of 'public Groups' should be interpreted as
the set of Groups availiable when creating an instance document,
extending the schema, or importing the schema.
See Also: Group |
| getId | | public String getId()(Code) | |
This method is intended to provide the ID of this Schema.
|
| getImports | | public Schema[] getImports()(Code) | |
This method is intended to provide a list of public Imports defined by
this Schema. The definition of 'public Imports' should be interpreted
as the set of Imports availiable when creating an instance document,
extending the schema, or importing the schema.
See Also: Schema |
| getPrefix | | public String getPrefix()(Code) | |
Gets the recommended prefix for this schema.
|
| getSimpleTypes | | public SimpleType[] getSimpleTypes()(Code) | |
This method is intended to provide a list of public SimpleTypes defined
by this Schema. The definition of 'public SimpleTypes' should be
interpreted as the set of SimpleTypes availiable when creating an
instance document, extending the schema, or importing the schema.
See Also: SimpleType |
| getTargetNamespace | | public URI getTargetNamespace()(Code) | |
This returns the intended use name of the Schema (kinda like an ID, for
a better definition see the XML Schema Specification).
|
| getVersion | | public String getVersion()(Code) | |
This returns the Schema version ...
|
| includesURI | | public boolean includesURI(URI uri)(Code) | |
This looks to see if the URI passed in is represented by this Schema.
Often this method uses some heuritics on the list of included URIs.
This allows one Schema to represent one targetNamespace, but be
potentially represented in more than one file.
Used to determine if the uri should provided should be included in an
instance document.
Parameters:
uri -
See Also: Schema.getUris() |
| isAttributeFormDefault | | public boolean isAttributeFormDefault()(Code) | |
Returns true when the Default Attribute Form is qualified, false
otherwise.
|
| isElementFormDefault | | public boolean isElementFormDefault()(Code) | |
Returns true when the Default Element Form is qualified, false
otherwise.
|
|
|