org.openspml.v2.profiles.spmldsml
Class DSMLSchema

java.lang.Object
  org.openspml.v2.util.xml.BasicMarshallableElement
      org.openspml.v2.msg.spml.Extensible
          org.openspml.v2.profiles.spmldsml.ExtensibleElement
              org.openspml.v2.profiles.spmldsml.DSMLSchema

All Implemented Interfaces:

Marshallable, MarshallableElement, OpenContentContainer, OpenContentElement

public class DSMLSchema

extends org.openspml.v2.profiles.spmldsml.ExtensibleElement

implements Marshallable, OpenContentElement

Constructor Summary

DSMLSchema()

DSMLSchema(ObjectClassDefinition[] objectClassDefs, AttributeDefinition[] attributeDefs)

Method Summary

void	addAttributeDefinition(AttributeDefinition reference)
void	addObjectClassDefinition(ObjectClassDefinition reference)
void	clearAttributeDefinitions()
void	clearObjectClassDefinitions()
boolean	equals(java.lang.Object o)
AttributeDefinition[]	getAttributeDefinitions()
java.lang.String	getElementName() This should return the name of the element to be placed in the XML
PrefixAndNamespaceTuple[]	getNamespacesInfo() We need to know the namespace of the class to include.
ObjectClassDefinition[]	getObjectClassDefinitions()
int	hashCode()
boolean	isValid() Most of the checks can be handled with setters/getters and assertions.
boolean	removeAttributeDefinition(AttributeDefinition reference)
boolean	removeObjectClassDefinition(ObjectClassDefinition reference)
java.lang.String	toXML() Would usually call toXml(int) with 0 indent.
java.lang.String	toXML(int indent) Convert this object to an XML string.
java.lang.String	toXML(XMLMarshaller m) Visitor pattern - dispatch this type to the visitor (m) please.

Methods inherited from class org.openspml.v2.msg.spml.Extensible

addOpenContentAttr, addOpenContentAttr, addOpenContentElement, findOpenContentAttrValueByName, findOperationalAttrByName, findOperationalNVPByName, getOpenContentAttrs, getOpenContentElements, getOpenContentElements, removeAllOperationalNVPsWithName, removeOpenContentAttr, removeOpenContentElement, setOpenContent, setOpenContentAttrs, setOpenContentElements

Methods inherited from class org.openspml.v2.util.xml.BasicMarshallableElement

getElementName

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.openspml.v2.msg.MarshallableElement

getNamespacesInfo

Constructor Detail

DSMLSchema

public DSMLSchema()

DSMLSchema

public DSMLSchema(ObjectClassDefinition[] objectClassDefs,
                  AttributeDefinition[] attributeDefs)

Method Detail

getElementName

public java.lang.String getElementName()

Description copied from interface: MarshallableElement

This should return the name of the element to be placed in the XML

Specified by:

getElementName in interface MarshallableElement

getObjectClassDefinitions

public ObjectClassDefinition[] getObjectClassDefinitions()

addObjectClassDefinition

public void addObjectClassDefinition(ObjectClassDefinition reference)

removeObjectClassDefinition

public boolean removeObjectClassDefinition(ObjectClassDefinition reference)

clearObjectClassDefinitions

public void clearObjectClassDefinitions()

getAttributeDefinitions

public AttributeDefinition[] getAttributeDefinitions()

addAttributeDefinition

public void addAttributeDefinition(AttributeDefinition reference)

removeAttributeDefinition

public boolean removeAttributeDefinition(AttributeDefinition reference)

clearAttributeDefinitions

public void clearAttributeDefinitions()

toXML

public java.lang.String toXML(XMLMarshaller m)
                       throws Spml2Exception

Description copied from interface: Marshallable

Visitor pattern - dispatch this type to the visitor (m) please.

Specified by:

toXML in interface Marshallable

Parameters:

m -

Returns:

xml

Throws:

Spml2Exception

isValid

public boolean isValid()

Most of the checks can be handled with setters/getters and assertions.

Specified by:

isValid in interface MarshallableElement

Overrides:

isValid in class Extensible

Returns:

true if valid, false otherwise.

toXML

public java.lang.String toXML(int indent)
                       throws Spml2Exception

Description copied from interface: OpenContentElement

Convert this object to an XML string.

Specified by:

toXML in interface OpenContentElement

Parameters:

indent - how much indent to start with.

Returns:

indented xml fragment

Throws:

Spml2Exception

toXML

public java.lang.String toXML()
                       throws Spml2Exception

Description copied from interface: OpenContentElement

Would usually call toXml(int) with 0 indent.

Specified by:

toXML in interface OpenContentElement

Returns:

xml fragment

Throws:

Spml2Exception

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class Extensible

hashCode

public int hashCode()

Overrides:

hashCode in class Extensible

getNamespacesInfo

public PrefixAndNamespaceTuple[] getNamespacesInfo()

Description copied from interface: MarshallableElement

We need to know the namespace of the class to include.

Specified by:

getNamespacesInfo in interface MarshallableElement

Overrides:

getNamespacesInfo in class Extensible