COSMOS ${releaseVersion} resource-modeling Project
Internal API Specification

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

java.lang.Object
  extended by org.xml.sax.helpers.DefaultHandler
      extended by org.eclipse.cosmos.rm.validation.internal.databuilders.AbstractDataBuilder
          extended by org.eclipse.cosmos.rm.validation.internal.databuilders.ElementSourceBuilder
All Implemented Interfaces:
IDataBuilder, org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler

public class ElementSourceBuilder
extends AbstractDataBuilder

This class will obtain the source for all instance and XML schema documents for the purpose of Schema validation, also obtaining line number information.


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
ElementSourceBuilder(java.lang.String smlifFile)
           
 
Method Summary
 void endElement(java.lang.String uri, java.lang.String localName, java.lang.String qName)
           
 java.lang.Object getDataStructure()
          Returns the data structure.
 java.util.List getInstances()
           
 byte getPhase()
          Specifies the phase that this data builder is active during parsing.
 java.util.List getSchemas()
           
 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
characters, 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
characters, 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

ElementSourceBuilder

public ElementSourceBuilder(java.lang.String smlifFile)
Method Detail

startElement

public void startElement(java.lang.String uri,
                         java.lang.String localName,
                         java.lang.String qName,
                         org.xml.sax.Attributes attributes)
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
See Also:
AbstractDataBuilder.startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)

endElement

public void endElement(java.lang.String uri,
                       java.lang.String localName,
                       java.lang.String qName)
Specified by:
endElement in interface org.xml.sax.ContentHandler
Overrides:
endElement in class AbstractDataBuilder
See Also:
AbstractDataBuilder.endElement(java.lang.String, java.lang.String, java.lang.String)

getSchemas

public java.util.List getSchemas()

getInstances

public java.util.List getInstances()

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()

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

COSMOS ${releaseVersion} resource-modeling Project
Internal API Specification