com.bowstreet.webapp
Interface Schema

All Superinterfaces:

IExemplar, WebAppObject

public interface Schema
extends WebAppObject

Class that represents a Schema

Field Summary

static int	SCHEMA_CONSTRUCTED
static int	SCHEMA_ORIGIN_SOURCE
static int	SCHEMA_ORIGIN_URL

Fields inherited from interface com.bowstreet.webapp.WebAppObject

ALWAYS_VISIBLE, INFORMATION_PROPERTY, NEVER_VISIBLE, SOMETIMES_VISIBLE

Method Summary

void	addDataDefinition(DataDefinitionElement element) Adds a pre-constructed DataDefinitionElement.
DataDefinitionContainer	addDataDefinitionContainer(java.lang.String name) Create an empty DataDefinitionContainer
DataDefinitionLeaf	addDataDefinitionLeaf(java.lang.String name) Create an empty DataDefinitionLeaf
DataDefinitionElement	findDataDefinition(java.lang.String name) Find a named DataDefinitionElement
java.util.Collection	getDataDefinitions()
java.lang.String	getImportsLoc() return the path for the imports
java.lang.Object	getOriginObject() Returns a reference to the original object (URL, or String of variable name or String of original source) used to construct the Schema.
Schema	getSchema() Returns a com.bowstreet.xml.schema.Schema object that exposes methods for accessing elements, namespace etc within the xsd/dtd.
int	getType() Returns an indicator (SCHEMA_ORIGIN_xx) of the origin of the Schema, whether sourced from a Variable, a URL, or actual source.

Methods inherited from interface com.bowstreet.webapp.WebAppObject

clone, getBuilderCall, getName, getProperties, getProperty, getVisibility, isHidden, putProperty, setBuilderCall, setHidden, setName, setVisibility

Methods inherited from interface com.bowstreet.util.IExemplar

newInstance

Field Detail

SCHEMA_CONSTRUCTED

static final int SCHEMA_CONSTRUCTED

See Also:

Constant Field Values

SCHEMA_ORIGIN_SOURCE

static final int SCHEMA_ORIGIN_SOURCE

See Also:

Constant Field Values

SCHEMA_ORIGIN_URL

static final int SCHEMA_ORIGIN_URL

See Also:

Constant Field Values

Method Detail

addDataDefinition

void addDataDefinition(DataDefinitionElement element)

Adds a pre-constructed DataDefinitionElement. Typically, it was cloned from somewhere else. Be sure to correct the internal WebApp references in it!!

Parameters:

element - The DDE to add.

addDataDefinitionContainer

DataDefinitionContainer addDataDefinitionContainer(java.lang.String name)

Create an empty DataDefinitionContainer

Parameters:

name - must be unique within this Schema

Returns:

a new DataDefinitionContainer

addDataDefinitionLeaf

DataDefinitionLeaf addDataDefinitionLeaf(java.lang.String name)

Create an empty DataDefinitionLeaf

Parameters:

name - must be unique within this Schema

Returns:

a new DataDefinitionLeaf

findDataDefinition

DataDefinitionElement findDataDefinition(java.lang.String name)

Find a named DataDefinitionElement

Parameters:

name - case-sensitive name. May contain slashes, in which case you will recieve node within tree

Returns:

Element with the name -- possibly null

getDataDefinitions

java.util.Collection getDataDefinitions()

Returns:

The collection of DataDefinitionElements contained

getImportsLoc

java.lang.String getImportsLoc()

return the path for the imports

getOriginObject

java.lang.Object getOriginObject()

Returns a reference to the original object (URL, or String of variable name or String of original source) used to construct the Schema.

getSchema

Schema getSchema()

Returns a com.bowstreet.xml.schema.Schema object that exposes methods for accessing elements, namespace etc within the xsd/dtd.

getType

int getType()

Returns an indicator (SCHEMA_ORIGIN_xx) of the origin of the Schema, whether sourced from a Variable, a URL, or actual source.