com.bluestream.xdb.dsobject.content
Interface SchemaInfo

public interface SchemaInfo

This class contains information about a schema.

Field Summary

static int	kdfExpGlobals Display tree will contained exported globals in targetNS - good for XSD
static int	kdfUnRefExpGlobals Display tree will contained only unreferenced nodes - good for DTD.

Method Summary

List	getDescSupportingSchemaNames() Get the names of all the descendant schemas that support this schema via this schema's import or include.
DisplayNode	getDisplayTree(int flag) Gets the display tree for this schema.
String	getName() Gets the name of this Schema.
int	getPathBaseType(String path) get path base type.
ElementDN	getRootElementDisplayTree(String rootElementName) Returns ElementDN for specified root element.
Vector	getRootElementNames() Return a vector of the String names of root schema elements for the schema associated with this SchemaInfo.
int	getSchemaSize() Returns the size of schema text in characters.
String	getSchemaText() Get the schema text in the original form.
String	getSchemaType()
String	getTargetURI()

Field Detail

kdfUnRefExpGlobals

public static final int kdfUnRefExpGlobals

Display tree will contained only unreferenced nodes - good for DTD.

See Also:

Constant Field Values

kdfExpGlobals

public static final int kdfExpGlobals

Display tree will contained exported globals in targetNS - good for XSD

See Also:

Constant Field Values

Method Detail

getName

public String getName()

Gets the name of this Schema. This is the name that the schema will be known as in all places. This is set when the schema is created.

getSchemaType

public String getSchemaType()

Returns:

schemaType: One of Schema.kSchemaTypeW3C or Schema.kSchemaTypeDTD.

getTargetURI

public String getTargetURI()

Returns:

targetURI: The target namespace uri. Returns null for the null namespace.

getDisplayTree

public DisplayNode getDisplayTree(int flag)
                           throws XDBException

Gets the display tree for this schema.

Returns:

display node - will be a RootDN.

Throws:

XDBException - - EC_Schema: Schema error

getRootElementDisplayTree

public ElementDN getRootElementDisplayTree(String rootElementName)
                                    throws XDBException

Returns ElementDN for specified root element.

Returns:

ElementDN the node corresponding to the rootElementName or null, if none exists.

Throws:

XDBException - - EC_Schema: Schema error

getRootElementNames

public Vector getRootElementNames()

Return a vector of the String names of root schema elements for the schema associated with this SchemaInfo. These are global names that exist in the target namespace of the schema - for use elsewhere. These names can subsequently be used on the ALTER ROOT statement to specify a schema and its rootname in {SchemaName}:{RootElementName} format.

getSchemaText

public String getSchemaText()

Get the schema text in the original form. This will be either DTD or W3c schema form.

getDescSupportingSchemaNames

public List getDescSupportingSchemaNames()

Get the names of all the descendant schemas that support this schema via this schema's import or include. NOTE: This method does not eliminate duplicates, so if a schema is included twice it will show up twice in the decendent list.

Returns:

nameList. List of schema names.

getSchemaSize

public int getSchemaSize()

Returns the size of schema text in characters.

getPathBaseType

public int getPathBaseType(String path)

get path base type. Using the global elements in this schema, drill down and determine the base type of this path.

Returns:

baseType. One of the base types defined in com.bluestream.xdb.BaseType.