com.wm.xmldata.xmldocumenttype

Class XmlDataWorkspace

java.lang.Object

com.wm.xmldata.xmldocumenttype.XmlDataWorkspace

public class XmlDataWorkspace
extends java.lang.Object

Provides a workspace in which XmlData Records and Fields can be accessed or created on an ad-hoc basis. An XmlDataWorkspace is functionally equivalent to the collection of document types created in a single conversion step from a collection of XML Schemas (for example what happens when a Designer user creates a collection of XmlData Document Types from a schema). This collection is created in a namespace folder with various XML namespace components created in subfolders of the base folder. The intent is that these NSNodes should be functionally identical to those created by the XmlDataDocumentConverter. Their primary application is to work with the XmlDataMap and XmlDataCopy classes using either ad-hoc document types or document types that have been created from a schema and already exist in a namespace. However, at present, ad-hoc document types cannot reference document types that already exist in a namespace.

Constructor Summary

Constructors

Constructor and Description
XmlDataWorkspace() Creates a temporary workspace.
XmlDataWorkspace(Namespace ns) Creates an XmlDataWorkspace using an existing namespace.
XmlDataWorkspace(Namespace ns, boolean readOnly) Creates a workspace using the specified namespace.

Method Summary

Modifier and Type	Method and Description
XmlAll	all(XmlModelItem... items) Creates an XmlAll definition in this workspace.
XmlAny	any(int min, int max, java.lang.String process, java.lang.String... namespaces) Creates an XmlAny definition in this workspace.
XmlAnyType	anyType() Creates an XmlAnyType definition in this workspace.
XmlAttribute	attribute(XmlDataAttributeTag aName) Creates a global attribute definition in this workspace and adds it to the associated namespace.
XmlAttribute	attribute(XmlDataAttributeTag aName, boolean required) Creates a local Attribute definition in this workspace.
XmlAttributeList	attributeList(XmlAttributeItem... attributes) Creates an XmlAttribute List in this workspace.
XmlAttributeRef	attributeRef(XmlDataAttributeTag aName, boolean required) Creates an attribute reference in this workspace.
XmlChoice	choice(int min, int max, XmlModelItem... items) Creates an XmlChoice definition with a minOccur and a maxOccurs in this workspace.
XmlChoice	choice(XmlModelItem... items) Creates an XmlChoice definition with max/max occurs of 1/1 in this workspace.
XmlComplexType	complexType(XmlContent model, XmlAttributeList aList) Creates an anonymous complexType definition in this workspace.
XmlComplexType	complexType(XmlDataTypeTag typeName, XmlContent content, XmlAttributeList aList) Creates a named (global) complexType definition in this workspace and adds it to the associated namespace.
XmlComplexTypeRef	complexTypeRef(XmlDataTypeTag typeName) Creates an XmlComplexTypeRef definition in this workspace.
void	convertSchema(java.lang.String script) Converts a script schema into a collection of document types stored in the workspace.
void	convertSchema(java.lang.String script, java.lang.String namespaceDecls) Converts a script schema and namespace map into a collection of document types stored in the workspace.
void	convertSchema(java.lang.String script, XmlNamespaceMap map) Converts a script schema and namespace map into a collection of document types stored in the workspace.
XmlElement	element(XmlDataElementTag eTag, XmlType model) Creates a global element definition in this namespace and adds it to the associated namespace.
XmlElement	element(XmlDataElementTag eTag, XmlType model, int min, int max) Creates a local element definition in this workspace.
XmlElementRef	elementRef(XmlDataElementTag eTag, int min, int max, boolean useFieldRef) Creates an XmlElementRef definition in this workspace.
NSField	getAttribute(XmlDataAttributeTag name) Returns the NSField for a global attribute.
NSName	getAttributeNSName(XmlDataAttributeTag name) Computes the NSName for a global attribute.
NSField	getElement(XmlDataElementTag name) Returns the definition for a global element.
NSName	getElementNSName(XmlDataElementTag name) Computes the NSName for a global element.
java.lang.String	getFolder() Returns the folder name of the generated nodes.
NSNode	getNodeByFullName(java.lang.String fullName) Gets a node (typically an NSRecord or an NSField) by using its full name.
Namespace	getNs() Returns the namespace on which this workspace was created.
NSField	getType(XmlDataTypeTag name) Returns the NSField that defines the named type.
NSName	getTypeNSName(XmlDataTypeTag name) Computes the NSName for a named complex type
NSField	getWrapper(XmlDataElementTag name) Returns the wrapper for a global element.
NSName	getWrapperNSName(XmlDataElementTag name) Computes the NSName for a root element wrapper.
XmlSequence	sequence(int min, int max, XmlModelItem... items) Creates an XmlSequence definition with minOccurs and maxOccurs in this workspace.
XmlSequence	sequence(XmlModelItem... items) Creates an XmlSequence definition with min/max occurs of 1/1 in this workspace.
void	setFolder(java.lang.String name) Sets the folder name of the generated nodes.
XmlSimpleType	simpleType() Creates an XmlSimpleType definition in this workspace.
XmlSubstitution	substitution(XmlDataElementTag... tags) Defines a substitution group in this workspace.
XmlWrapper	wrapper(XmlDataElementTag elementName, boolean useFieldRef) Creates an XmlWrapper (complexType with single member document element) in this workspace and adds it to the namespace.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XmlDataWorkspace

public XmlDataWorkspace(Namespace ns)

Creates an XmlDataWorkspace using an existing namespace. Typically, this will be a persisted namespace with document types that were created from an XML Schema.

Parameters:

ns - the com.wm.lang.ns.Namespace to access

XmlDataWorkspace

public XmlDataWorkspace()

Creates a temporary workspace. A temporary workspace has a transient namespace that is not persisted anywhere. It is strictly temporary and is typically used to create ad-hoc document types for use by XmlDataMap, XmlDataCOpy, and XMlDataPath.

XmlDataWorkspace

public XmlDataWorkspace(Namespace ns,
                        boolean readOnly)

Creates a workspace using the specified namespace. The workspace may optionally be declared to be read-only.

Parameters:

ns - the namespace

readOnly - if true, no components may be added to the namespace

Method Detail

getNs

public Namespace getNs()

Returns the namespace on which this workspace was created.

Returns:

the underlying namespace

convertSchema

public void convertSchema(java.lang.String script,
                          java.lang.String namespaceDecls)

Converts a script schema and namespace map into a collection of document types stored in the workspace.

Parameters:

script - the schema specified in script form. See XmlDataSchemaConverter for the format.

namespaceDecls - namespace declarations specified as a String containing prefix URI pairs

convertSchema

public void convertSchema(java.lang.String script)

Converts a script schema into a collection of document types stored in the workspace. If the schema uses namespace-qualified components, the script must include a namespace map preamble in the form "{ prefix1 ns1 ...}"

Parameters:

script - the schema specified in script form. See XmlDataSchemaConverter for the format.

convertSchema

public void convertSchema(java.lang.String script,
                          XmlNamespaceMap map)

Converts a script schema and namespace map into a collection of document types stored in the workspace.

Parameters:

script - the schema specified in script form. See XmlDataSchemaConverter for the format.

map - a namespace map

all

public XmlAll all(XmlModelItem... items)

Creates an XmlAll definition in this workspace.

Parameters:

items - a list of member items (XmlElements and XmlElementRefs)

Returns:

the definition

any

public XmlAny any(int min,
                  int max,
                  java.lang.String process,
                  java.lang.String... namespaces)

Creates an XmlAny definition in this workspace.

Parameters:

min - minOccurs

max - maxOccurs

process - processContents (strict, lax or skip)

namespaces - ##any; ##other name; name1 name2 ... (which may include ##local)

Returns:

the definition

anyType

public XmlAnyType anyType()

Creates an XmlAnyType definition in this workspace.

Returns:

The definition.

attribute

public XmlAttribute attribute(XmlDataAttributeTag aName)

Creates a global attribute definition in this workspace and adds it to the associated namespace.

Parameters:

aName - the attribute name

Returns:

the Attribute definition

attribute

public XmlAttribute attribute(XmlDataAttributeTag aName,
                              boolean required)

Creates a local Attribute definition in this workspace.

Parameters:

aName - the attribute name

required - boolean flag indicating required

Returns:

The definition

attributeList

public XmlAttributeList attributeList(XmlAttributeItem... attributes)

Creates an XmlAttribute List in this workspace.

Parameters:

attributes - a list of XmlAttributes and XmlAttributeRefs)

Returns:

a constructed XmlAttributeList

See Also:

XmlAttributeList(XmlDataWorkspace, XmlAttributeItem...)

attributeRef

public XmlAttributeRef attributeRef(XmlDataAttributeTag aName,
                                    boolean required)

Creates an attribute reference in this workspace.

Parameters:

aName - the name of the referenced attribute

required - boolean flag indicating required attribute

Returns:

rhe definition

See Also:

XmlAttributeRef(XmlDataWorkspace, XmlDataAttributeTag, boolean)

choice

public XmlChoice choice(XmlModelItem... items)

Creates an XmlChoice definition with max/max occurs of 1/1 in this workspace.

Parameters:

items - a list of content items (XmlElement, XmlElementREf, XmlAny, XmlChoice, and XmlSequence.

Returns:

the definition

See Also:

XmlChoice(XmlDataWorkspace, int, int, XmlModelItem...)

choice

public XmlChoice choice(int min,
                        int max,
                        XmlModelItem... items)

Creates an XmlChoice definition with a minOccur and a maxOccurs in this workspace.

Parameters:

min - minOccurs

max - maxOccurs

items - a list of content items (XmlElement, XmlElementRef, XmlAny, XmlChoice, and XmlSequence.

Returns:

the definition

See Also:

XmlChoice(XmlDataWorkspace, int, int, XmlModelItem...)

complexType

public XmlComplexType complexType(XmlContent model,
                                  XmlAttributeList aList)

Creates an anonymous complexType definition in this workspace.

Parameters:

model - a subclass of XmlGroup defining the content model (XmlAll, XmlChoice, or XmlSequence).

aList - an XmlAttributeList

Returns:

the definition

See Also:

XmlComplexType(XmlDataWorkspace, XmlContent, XmlAttributeList)

complexType

public XmlComplexType complexType(XmlDataTypeTag typeName,
                                  XmlContent content,
                                  XmlAttributeList aList)

Creates a named (global) complexType definition in this workspace and adds it to the associated namespace.

Parameters:

typeName - the global name of the type

content - the content model: an instance of XmlSequence, XmlChoice, XmlAll, or XmlSimpleType

aList - an AttributeList

Returns:

the definition

See Also:

XmlComplexType(XmlDataWorkspace, XmlDataTypeTag, XmlContent, XmlAttributeList)

complexTypeRef

public XmlComplexTypeRef complexTypeRef(XmlDataTypeTag typeName)

Creates an XmlComplexTypeRef definition in this workspace.

Parameters:

typeName - the name of the referenced type

Returns:

the definition

See Also:

XmlComplexTypeRef(XmlDataWorkspace, XmlDataTypeTag)

element

public XmlElement element(XmlDataElementTag eTag,
                          XmlType model)

Creates a global element definition in this namespace and adds it to the associated namespace.

Parameters:

eTag - the element global name

model - an XmlType (XmlComplexType, XmlComplexTypeRef, XmlAnyType, XmlSimpleType)

Returns:

the definition

See Also:

XmlElement(XmlDataWorkspace, XmlDataElementTag, XmlType)

element

public XmlElement element(XmlDataElementTag eTag,
                          XmlType model,
                          int min,
                          int max)

Creates a local element definition in this workspace.

Parameters:

eTag - the name of the element

model - an XmlType (XmlComplexType, XmlComplexTypeRef, XmlAnyType, XmlSimpleType)

min - minOccurs

max - maxOccurs

Returns:

the definition

See Also:

XmlElement(XmlDataWorkspace, XmlDataElementTag, XmlType, int, int)

elementRef

public XmlElementRef elementRef(XmlDataElementTag eTag,
                                int min,
                                int max,
                                boolean useFieldRef)

Creates an XmlElementRef definition in this workspace.

Parameters:

eTag - the name of the referenced global element

min - minOccurs

max - maxOccurs

useFieldRef - boolean flag indication this is an NSFieldRef (rather than an NSRecordRef). Should be set true only when the referenced global element has simple type.

Returns:

the definition

See Also:

XmlElementRef(XmlDataWorkspace, XmlDataElementTag, int, int, boolean)

getAttribute

public NSField getAttribute(XmlDataAttributeTag name)

Returns the NSField for a global attribute.

Parameters:

name - an XmlDataAttributeTag

Returns:

the defined Attribute

getAttributeNSName

public NSName getAttributeNSName(XmlDataAttributeTag name)

Computes the NSName for a global attribute.

Parameters:

name - the attribute name

Returns:

an NSName

getElement

public NSField getElement(XmlDataElementTag name)

Returns the definition for a global element.

Parameters:

name - an XmlDataElementTag

Returns:

the defined Element

getElementNSName

public NSName getElementNSName(XmlDataElementTag name)

Computes the NSName for a global element.

Parameters:

name - the element name

Returns:

an NSName

getFolder

public java.lang.String getFolder()

Returns the folder name of the generated nodes.

Returns:

String name of the folder

getNodeByFullName

public NSNode getNodeByFullName(java.lang.String fullName)

Gets a node (typically an NSRecord or an NSField) by using its full name. The current folder setting or the potential role of the node is not used in any way to interpret or qualify the name.

Parameters:

fullName - the full namespace name, e.g., myFolders.myFields:Address

Returns:

a Namespace object

getWrapper

public NSField getWrapper(XmlDataElementTag name)

Returns the wrapper for a global element.

Parameters:

name - an XmlDataElementTag

Returns:

the defined Element

getWrapperNSName

public NSName getWrapperNSName(XmlDataElementTag name)

Computes the NSName for a root element wrapper.

Parameters:

name - the element name

Returns:

an NSName

getType

public NSField getType(XmlDataTypeTag name)

Returns the NSField that defines the named type.

Parameters:

name - an XmlDataTypeTag

Returns:

the defined type

getTypeNSName

public NSName getTypeNSName(XmlDataTypeTag name)

Computes the NSName for a named complex type

Parameters:

name - the type name

Returns:

an NSName

sequence

public XmlSequence sequence(XmlModelItem... items)

Creates an XmlSequence definition with min/max occurs of 1/1 in this workspace.

Parameters:

items - a list of XmlElements, XmlElementRefs, XmlAnys, XmlSequences, and XmlChoices

Returns:

a constructed sequence

See Also:

XmlSequence(XmlDataWorkspace, int, int, XmlModelItem...)

sequence

public XmlSequence sequence(int min,
                            int max,
                            XmlModelItem... items)

Creates an XmlSequence definition with minOccurs and maxOccurs in this workspace.

Parameters:

min - minOccurs

max - maxOccurs

items - a list of XmlElements, XmlElementRefs, XmlAnys, XmlSequences, and XmlChoices

Returns:

the definition

See Also:

XmlSequence(XmlDataWorkspace, int, int, XmlModelItem...)

setFolder

public void setFolder(java.lang.String name)

Sets the folder name of the generated nodes. If not specified, it defaults to "temp".

Parameters:

name - the name of the folder (as used in generated NSNames)

simpleType

public XmlSimpleType simpleType()

Creates an XmlSimpleType definition in this workspace.

Returns:

the definition

See Also:

XmlSimpleType(XmlDataWorkspace)

substitution

public XmlSubstitution substitution(XmlDataElementTag... tags)

Defines a substitution group in this workspace. The head of the substitution group must not have been defined before this method is called, but all of the members must have been defined before this method is called.

Parameters:

tags - a list of XmlContentTags. The first tag is the head of the substitution group. The remaining tags identify the members.

Returns:

an XmlSubstitution definition

See Also:

XmlSubstitution(XmlDataWorkspace, XmlDataElementTag...)

wrapper

public XmlWrapper wrapper(XmlDataElementTag elementName,
                          boolean useFieldRef)

Creates an XmlWrapper (complexType with single member document element) in this workspace and adds it to the namespace.

Parameters:

elementName - the name of the root element

useFieldRef - a boolean set to true when the referenced element has SimpleType

Returns:

a constructed element wrapper

See Also:

XmlWrapper(XmlDataWorkspace, XmlDataElementTag, boolean)