org.eclipse.cosmos.rm.repository.internal.resource
Class SMLFileInstanceDocument

java.lang.Object
  org.eclipse.cosmos.rm.repository.internal.resource.SMLFileDocument
      org.eclipse.cosmos.rm.repository.internal.resource.SMLFileInstanceDocument

All Implemented Interfaces:

java.lang.Comparable, org.eclipse.cosmos.rm.repository.provisional.resource.ISMLDocument, org.eclipse.cosmos.rm.repository.provisional.resource.ISMLInstanceDocument

Direct Known Subclasses:

SMLFileResourceInstance

public class SMLFileInstanceDocument
extends SMLFileDocument
implements org.eclipse.cosmos.rm.repository.provisional.resource.ISMLInstanceDocument, java.lang.Comparable

The file system implementation of an instance SML document

Constructor Summary

SMLFileInstanceDocument(org.eclipse.cosmos.rm.repository.provisional.core.ISMLRepository repository)

Method Summary

int	compareTo(java.lang.Object arg0)
org.eclipse.cosmos.rm.repository.provisional.resource.ISMLDefinitionDocument	retrieveDefinition() Retrieves and returns the definition of this instance document.
org.eclipse.cosmos.rm.repository.provisional.resource.ISMLDocument[]	retrieveReferences(org.eclipse.cosmos.rm.repository.provisional.resource.ISMLMetadata metadata) Retrieves and returns all references of this document based on the meta-data passed in.
java.lang.String	toString()

Methods inherited from class org.eclipse.cosmos.rm.repository.internal.resource.SMLFileDocument

equals, getDOMDocument, getLastModifiedDate, getMetadata, getRepository, retrieveDocumentFragment, retrieveRootAttribute, setMetadata

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.cosmos.rm.repository.provisional.resource.ISMLDocument

getMetadata, retrieveDocumentFragment

Constructor Detail

SMLFileInstanceDocument

public SMLFileInstanceDocument(org.eclipse.cosmos.rm.repository.provisional.core.ISMLRepository repository)

Method Detail

retrieveReferences

public org.eclipse.cosmos.rm.repository.provisional.resource.ISMLDocument[] retrieveReferences(org.eclipse.cosmos.rm.repository.provisional.resource.ISMLMetadata metadata)
                                                                                        throws org.eclipse.cosmos.rm.repository.provisional.exception.RepositoryOperationException

Description copied from interface: org.eclipse.cosmos.rm.repository.provisional.resource.ISMLInstanceDocument

Retrieves and returns all references of this document based on the meta-data passed in. If the argument is null, then all references of this document are returned.

Specified by:

retrieveReferences in interface org.eclipse.cosmos.rm.repository.provisional.resource.ISMLInstanceDocument

Parameters:

metadata - Meta information used to filter the result set of document references.

Returns:

The document references of this SML document

Throws:

org.eclipse.cosmos.rm.repository.provisional.exception.RepositoryOperationException - In case of an error

See Also:

org.eclipse.cosmos.rm.repository.provisional.resource.ISMLDocument#retrieveReferences(org.eclipse.cosmos.rm.repository.provisional.resource.ISMLMetadata)

retrieveDefinition

public org.eclipse.cosmos.rm.repository.provisional.resource.ISMLDefinitionDocument retrieveDefinition()
                                                                                                throws org.eclipse.cosmos.rm.repository.provisional.exception.RepositoryOperationException

Description copied from interface: org.eclipse.cosmos.rm.repository.provisional.resource.ISMLInstanceDocument

Retrieves and returns the definition of this instance document. If the definition cannot be resolved, then null will be returned.

Specified by:

retrieveDefinition in interface org.eclipse.cosmos.rm.repository.provisional.resource.ISMLInstanceDocument

Returns:

The definition of this instance document or null if it cannot be determined.

Throws:

org.eclipse.cosmos.rm.repository.provisional.exception.RepositoryOperationException

See Also:

ISMLInstanceDocument.retrieveDefinition()

compareTo

public int compareTo(java.lang.Object arg0)

Specified by:

compareTo in interface java.lang.Comparable

See Also:

java.lang.Comparable#compareTo(T)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object