javax.wsdl.extensions.schema

Interface Schema

All Superinterfaces:

ExtensibilityElement, Serializable

All Known Implementing Classes:

SchemaImpl

public interface Schema
extends ExtensibilityElement, Serializable

Represents a schema element. This is a lightweight schema wrapper that provides access to the schema DOM element, but does not parse the schema details. The implementor may provide alternative schema parsing if required.

Author:

Jeremy Hughes

Method Summary

Methods

Modifier and Type	Method and Description
void	addImport(SchemaImport importSchema) Add an import to this LightWeightSchema
void	addInclude(SchemaReference includeSchema) Add an include to this LightWeightSchema
void	addRedefine(SchemaReference redefineSchema) Add a redefine to this LightWeightSchema
SchemaImport	createImport() Create a new schema import
SchemaReference	createInclude() Create a new schema reference to represent an include.
SchemaReference	createRedefine() Create a new schema reference to represent a redefine.
String	getDocumentBaseURI() Get the document base URI of this schema
Element	getElement() Get the DOM Element that represents this schema element.
Map	getImports() Get a map of lists containing all the imports defined here.
List	getIncludes() Get a list containing all of the includes defined here.
List	getRedefines() Get a list containing all of the redefines defined here.
void	setDocumentBaseURI(String documentBaseURI) Set the document base URI of this schema definition.
void	setElement(Element element) Set the DOM Element that represents this schema element.

Methods inherited from interface javax.wsdl.extensions.ExtensibilityElement

getElementType, getRequired, setElementType, setRequired

Method Detail

getImports

Map getImports()

Get a map of lists containing all the imports defined here. The map's keys are the namespaceURIs, and the map's values are lists. There is one list for each namespaceURI for which imports have been defined.

Returns:

a map of lists of schema imports

createImport

SchemaImport createImport()

Create a new schema import

Returns:

the newly created schema import

addImport

void addImport(SchemaImport importSchema)

Add an import to this LightWeightSchema

Parameters:

importSchema - the import to be added

getIncludes

List getIncludes()

Get a list containing all of the includes defined here. The list elements are schema references.

Returns:

a list of schema references.

createInclude

SchemaReference createInclude()

Create a new schema reference to represent an include.

Returns:

the newly created SchemaReference

addInclude

void addInclude(SchemaReference includeSchema)

Add an include to this LightWeightSchema

Parameters:

includeSchema - The include to be added, represented as a SchemaReference

getRedefines

List getRedefines()

Get a list containing all of the redefines defined here. The list elements are schema references.

Returns:

a list of schema references.

createRedefine

SchemaReference createRedefine()

Create a new schema reference to represent a redefine.

Returns:

the newly created SchemaReference

addRedefine

void addRedefine(SchemaReference redefineSchema)

Add a redefine to this LightWeightSchema

Parameters:

redefineSchema - The redefine to be added, represented as a SchemaReference

setElement

void setElement(Element element)

Set the DOM Element that represents this schema element.

Parameters:

element - the DOM element representing this schema

getElement

Element getElement()

Get the DOM Element that represents this schema element.

Returns:

the DOM element representing this schema

setDocumentBaseURI

void setDocumentBaseURI(String documentBaseURI)

Set the document base URI of this schema definition. Can be used to represent the origin of the schema, and can be exploited when resolving relative URIs (e.g. in <import>s).

Parameters:

documentBaseURI - the document base URI of this schema

getDocumentBaseURI

String getDocumentBaseURI()

Get the document base URI of this schema

Returns:

the document base URI