org.eclipse.cosmos.rm.validation.internal.databuilders
Class IdentityDataBuilder

java.lang.Object
  org.xml.sax.helpers.DefaultHandler
      org.eclipse.cosmos.rm.validation.internal.databuilders.AbstractDataBuilder
          org.eclipse.cosmos.rm.validation.internal.databuilders.IdentityDataBuilder

All Implemented Interfaces:

IDataBuilder, org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler

public class IdentityDataBuilder
extends AbstractDataBuilder

This databuilder constructs an SMLIFIdentity object which will include the content that is included in the identity section of an SML-IF document.

Nested Class Summary

static class

IdentityDataBuilder.SMLIFIdentity Stores the data included in the identity section of the SML-IF document

Field Summary

static java.lang.String

ID The ID of this builder

Fields inherited from class org.eclipse.cosmos.rm.validation.internal.databuilders.AbstractDataBuilder

locator

Constructor Summary

IdentityDataBuilder()
Constructor

Method Summary

void	characters(char[] ch, int start, int length)
void	endElement(java.lang.String uri, java.lang.String localName, java.lang.String qName)
java.lang.Object	getDataStructure() Returns the data structure.
byte	getPhase() Specifies the phase that this data builder is active during parsing.
static java.lang.String	retrieveBaseURI() Retrieves and returns the base URI
void	startElement(java.lang.String uri, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes attributes) This is used to determine the target name space of the document currently being parsed

Methods inherited from class org.eclipse.cosmos.rm.validation.internal.databuilders.AbstractDataBuilder

appendToErrorMessage, comment, endDefinitions, endInstances, getCurrentPhase, getDefaultNamespace, getErrorMessage, getFilePath, getPrefixMap, getTargetNamespace, isStructureValid, setDefaultNamespace, setDocumentLocator, setErrorMessage, setFilePath, setPrefixMap, setStructureValidity, setTargetNamespace, startDefinitions, startInstances, tokenizeName

Methods inherited from class org.xml.sax.helpers.DefaultHandler

endDocument, endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xml.sax.ContentHandler

endDocument, endPrefixMapping, ignorableWhitespace, processingInstruction, skippedEntity, startDocument, startPrefixMapping

Field Detail

ID

public static final java.lang.String ID

The ID of this builder

See Also:

Constant Field Values

Constructor Detail

IdentityDataBuilder

public IdentityDataBuilder()

Constructor

Method Detail

getPhase

public byte getPhase()

Description copied from interface: IDataBuilder

Specifies the phase that this data builder is active during parsing. The parser parses the sml document in two parts: Definitions and Instances phases. The valid values are as follows:

 ISMLConstants.DEFINITIONS_PHASE -databuilder is active during the parsing of the definitions elements
 ISMLConstants.INSTANCES_PHASE -databuilder is active during the parsing of the instances elements
 ISMLConstants.DEFINITIONS_INSTANCES_PHASE - databuilder is active during the parsing of the definitions and instances elements
 

Specified by:

getPhase in interface IDataBuilder

Overrides:

getPhase in class AbstractDataBuilder

Returns:

a phase that this databuilder will be active

See Also:

AbstractDataBuilder.getPhase()

startElement

public void startElement(java.lang.String uri,
                         java.lang.String localName,
                         java.lang.String qName,
                         org.xml.sax.Attributes attributes)
                  throws org.xml.sax.SAXException

Description copied from class: AbstractDataBuilder

This is used to determine the target name space of the document currently being parsed

Specified by:

startElement in interface org.xml.sax.ContentHandler

Overrides:

startElement in class AbstractDataBuilder

Throws:

org.xml.sax.SAXException

See Also:

AbstractDataBuilder.startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)

characters

public void characters(char[] ch,
                       int start,
                       int length)
                throws org.xml.sax.SAXException

Specified by:

characters in interface org.xml.sax.ContentHandler

Overrides:

characters in class org.xml.sax.helpers.DefaultHandler

Throws:

org.xml.sax.SAXException

See Also:

DefaultHandler.characters(char[], int, int)

endElement

public void endElement(java.lang.String uri,
                       java.lang.String localName,
                       java.lang.String qName)
                throws org.xml.sax.SAXException

Specified by:

endElement in interface org.xml.sax.ContentHandler

Overrides:

endElement in class AbstractDataBuilder

Throws:

org.xml.sax.SAXException

See Also:

AbstractDataBuilder.endElement(java.lang.String, java.lang.String, java.lang.String)

getDataStructure

public java.lang.Object getDataStructure()

Description copied from interface: IDataBuilder

Returns the data structure. The type of the structure must be specified as part of the specification of the class that implements this interface.

Returns:

The data structure

See Also:

IDataBuilder.getDataStructure()

retrieveBaseURI

public static java.lang.String retrieveBaseURI()

Retrieves and returns the base URI

Returns:

the base URI