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

org.eclipse.cosmos.rm.repository.internal.reference
Class SMLDocumentReference

java.lang.Object
  extended by org.eclipse.cosmos.rm.validation.internal.reference.URIReference
      extended by org.eclipse.cosmos.rm.repository.internal.reference.SMLDocumentReference
All Implemented Interfaces:
IReferenceExpression

public class SMLDocumentReference
extends URIReference

An SML document reference. This class can be used to retrieve the root DOM node of the referenced SML document.


Constructor Summary
SMLDocumentReference(org.eclipse.cosmos.rm.repository.provisional.core.ISMLRepository repositor, java.lang.String reference)
          The constructor
 
Method Summary
 java.net.URI getBase()
           
 org.w3c.dom.Node retrieveDocumentDOM()
          Retrieves the document node and returns the result
 void setBase(java.net.URI base)
           
 
Methods inherited from class org.eclipse.cosmos.rm.validation.internal.reference.URIReference
getDocumentReference, getFragment, getReference, isTransformed, setReference, transform
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SMLDocumentReference

public SMLDocumentReference(org.eclipse.cosmos.rm.repository.provisional.core.ISMLRepository repositor,
                            java.lang.String reference)
                     throws java.net.URISyntaxException
The constructor

Parameters:
repositor - The repository
reference - The referenced document
Throws:
java.net.URISyntaxException - If the reference is incorrect
Method Detail

retrieveDocumentDOM

public org.w3c.dom.Node retrieveDocumentDOM()
                                     throws java.net.URISyntaxException,
                                            SMLValidatorUtil.RemoteRetrievalException
Description copied from class: URIReference
Retrieves the document node and returns the result

Overrides:
retrieveDocumentDOM in class URIReference
Returns:
The document node
Throws:
java.net.URISyntaxException
SMLValidatorUtil.RemoteRetrievalException
See Also:
URIReference.retrieveDocumentDOM()

getBase

public java.net.URI getBase()
Overrides:
getBase in class URIReference
Returns:
the base

setBase

public void setBase(java.net.URI base)
Overrides:
setBase in class URIReference
Parameters:
base - the base to set

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