org.eclipse.cosmos.rm.validation.internal.reference
Interface IReferenceExpression

All Known Implementing Classes:

SMLDocumentReference, URIReference

public interface IReferenceExpression

This interface represents a reference expression used to reference an element in a document.

Method Summary

java.lang.String	getDocumentReference() Returns the document reference.
boolean	isTransformed() Returns true if this reference has already been transformed; false otherwise.
void	transform() The trasnformation of a reference is the process of converting a reference from a relative reference to an absolute one.

Method Detail

getDocumentReference

java.lang.String getDocumentReference()
                                      throws java.net.URISyntaxException

Returns the document reference. If isTransformed returns false, then transform is called before the document reference is returned.

Returns:

A reference to the document containing the element that is being referenced.

Throws:

java.net.URISyntaxException

transform

void transform()
               throws java.net.URISyntaxException

The trasnformation of a reference is the process of converting a reference from a relative reference to an absolute one.

Throws:

java.net.URISyntaxException

isTransformed

boolean isTransformed()

Returns true if this reference has already been transformed; false otherwise.

Returns:

true if already transformed; false otherwise.