Trait

org.omg.oti.uml.canonicalXMI

DocumentOps

Related Doc: package canonicalXMI

Permalink

trait DocumentOps[Uml <: UML] extends AnyRef

OMG Tool-neutral API extension for document-related processing of OMG UML 2.5 compliant models

Uml

Type signature of a tool-specific adaptation of OMG UML 2.5

See also

OMG XMI 2.5, formal/2015-06-07 http://www.omg.org/spec/XMI/2.5.1

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DocumentOps
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def addBuiltInImmutableDocument(ds: DocumentSet[Uml], info: OTISpecificationRootCharacteristics, documentURL: Uml.LoadURL, root: UMLPackage[Uml], builtInExtent: Set[UMLElement[Uml]]): \/[Set[Throwable], (BuiltInImmutableDocument[Uml], DocumentSet[Uml])]

    Permalink

    Create a BuiltInMutableDocument for a root package scope whose contents are subject to change.

    Create a BuiltInMutableDocument for a root package scope whose contents are subject to change.

    ds

    DocumentSet

    info

    the OTI specification characteristics of the scope UML Package as the root of an OTI document

    documentURL

    the LoadURL information about the external URL from where the contents of built-in document contents correspond to those of the root package

    root

    a tool-specific root package corresponding to the tool-specific implementation of an OMG-defined document (e.g., the OMG UML2.5 PrimitiveTypes library)

    returns

    A tuple with:

    • a BuiltInDocument, d
    • a DocumentSet, ds', which is ds + d
    See also

    OMG XMI 2.5.1, formal/2015-06-07, section 7.13.2 Procedures, Document Import

  2. abstract def addBuiltInMutableDocument(ds: DocumentSet[Uml], info: OTISpecificationRootCharacteristics, documentURL: Uml.LoadURL, root: UMLPackage[Uml]): \/[Set[Throwable], (BuiltInMutableDocument[Uml], DocumentSet[Uml])]

    Permalink

    Create a BuiltInImmutableDocument for a root package scope whose contents are fully known.

    Create a BuiltInImmutableDocument for a root package scope whose contents are fully known.

    ds

    DocumentSet

    info

    the OTI specification characteristics of the scope UML Package as the root of an OTI document

    documentURL

    the LoadURL information about the external URL from where the contents of built-in document contents correspond to those of the root package

    root

    a tool-specific root package corresponding to the tool-specific implementation of an OMG-defined document (e.g., the OMG UML2.5 PrimitiveTypes library)

    returns

    A tuple with:

    • a BuiltInDocument, d
    • a DocumentSet, ds', which is ds + d
    See also

    OMG XMI 2.5.1, formal/2015-06-07, section 7.13.2 Procedures, Document Import

  3. abstract def addDocument(ds: DocumentSet[Uml], d: Document[Uml]): \/[Set[Throwable], DocumentSet[Uml]]

    Permalink

    Add a document as a new node to an existing document set graph

    Add a document as a new node to an existing document set graph

    ds

    A DocumentSet graph

    d

    A Document to add as a new node to ds

    returns

    A new DocumentSet, ds', whose nodes should be ds'=d + ds.documents

  4. abstract def addLoadingMutableDocument(ds: DocumentSet[Uml], info: OTISpecificationRootCharacteristics, documentURL: Uml.LoadURL, root: UMLPackage[Uml]): \/[Set[Throwable], (LoadingMutableDocument[Uml], DocumentSet[Uml])]

    Permalink

    Create a LoadingMutableDocument for a root package scope whose contents are subject to change

    Create a LoadingMutableDocument for a root package scope whose contents are subject to change

    ds

    DocumentSet

    info

    the OTI specification characteristics of the scope UML Package as the root of an OTI document

    documentURL

    the LoadURL information about the external URL from where the serializable document contents will be read into the contents of the root package

    root

    the root package scope of the OTI serializable document

    returns

    If successful, a SerializableDocument for the root package scope

    See also

    OMG XMI 2.5.1, formal/2015-06-07, section 7.13.2 Procedures, Document Import

  5. abstract def addSerializableImmutableDocument(ds: DocumentSet[Uml], info: OTISpecificationRootCharacteristics, documentURL: Uml.LoadURL, root: UMLPackage[Uml]): \/[Set[Throwable], (SerializableImmutableDocument[Uml], DocumentSet[Uml])]

    Permalink

    Create a SerializableImmutableDocument for an existing root package whose contents are fully known

    Create a SerializableImmutableDocument for an existing root package whose contents are fully known

    ds

    DocumentSet

    info

    the OTI specification characteristics of the scope UML Package as the root of an OTI document

    documentURL

    the LoadURL information about the external URL from where the serializable document contents will be read into the contents of the root package

    root

    The root package scope of the serializable document

    returns

    A SerializableDocument if the root package has the necessary information to specify how it should be eventually serialized per OMG XMI 2.5.1

    See also

    OMG XMI 2.5.1, formal/2015-06-07, section 7.13.2 Procedures, Document Creation

  6. abstract def addSerializableMutableDocument(ds: DocumentSet[Uml], info: OTISpecificationRootCharacteristics, documentURL: Uml.LoadURL, root: UMLPackage[Uml]): \/[Set[Throwable], (SerializableMutableDocument[Uml], DocumentSet[Uml])]

    Permalink

    Create a SerializableMutableDocument for a root package scope whose contents are subject to change

    Create a SerializableMutableDocument for a root package scope whose contents are subject to change

    ds

    DocumentSet

    info

    the OTI specification characteristics of the scope UML Package as the root of an OTI document

    documentURL

    the LoadURL information about the external URL from where the serializable document contents will be read into the contents of the root package

    root

    the root package scope of the OTI serializable document

    returns

    If successful, a SerializableDocument for the root package scope

    See also

    OMG XMI 2.5.1, formal/2015-06-07, section 7.13.2 Procedures, Document Import

  7. abstract def createDocumentSet(documents: Set[Document[Uml]], documentURIMapper: CatalogURIMapper, builtInURIMapper: CatalogURIMapper, aggregate: Uml.DocumentSetAggregate)(implicit ops: UMLOps[Uml], nodeT: scala.reflect.api.JavaUniverse.TypeTag[Document[Uml]], edgeT: scala.reflect.api.JavaUniverse.TypeTag[DocumentEdge[Document[Uml]]]): \&/[Set[Throwable], DocumentSet[Uml]]

    Permalink

    Create a DocumentSet graph for document nodes (serializable or built-in) and inter-document edges

    Create a DocumentSet graph for document nodes (serializable or built-in) and inter-document edges

    documents

    The set of document nodes

    documentURIMapper

    OASIS XML Catalog-based mapping of package or element URIs to serializable document URLs and element URIs

    builtInURIMapper

    OASIS XML Catalog-based mapping of package or element URIs to OMG-published document URLs and element URIs

    aggregate

    Document Set Aggregate

    ops

    OTI UML Read Operations API

    nodeT

    Scala type information about Document[UML] graph nodes

    edgeT

    Scala type information about Document[UML] to Document[UML] graph edges

    returns

    A DocumentSet graph

  8. abstract def getExternalDocumentURL(lurl: Uml.LoadURL): \/[Set[Throwable], URI]

    Permalink

    Get the URI of the document as an externally accessible resource.

    Get the URI of the document as an externally accessible resource.

    lurl

    The LoadURL coordinates of the external document to load

    returns

    The URI where the document can be accesssed as an external resource

  9. abstract def initializeDocumentSet(documentURIMapper: CatalogURIMapper, builtInURIMapper: CatalogURIMapper)(implicit nodeT: scala.reflect.api.JavaUniverse.TypeTag[Document[Uml]], edgeT: scala.reflect.api.JavaUniverse.TypeTag[DocumentEdge[Document[Uml]]]): \&/[Set[Throwable], DocumentSet[Uml]]

    Permalink

    Create an initial DocumentSet graph with built-in document nodes/edges for OMG UML 2.5

    Create an initial DocumentSet graph with built-in document nodes/edges for OMG UML 2.5

    documentURIMapper

    OASIS XML Catalog-based mapping of package or element URIs to serializable document URLs and element URIs

    builtInURIMapper

    OASIS XML Catalog-based mapping of package or element URIs to OMG-published document URLs and element URIs

    nodeT

    Scala type information about Document[UML] graph nodes

    edgeT

    Scala type information about Document[UML] to Document[UML] graph edges

    returns

    A DocumentSet graph

  10. abstract def openExternalDocumentStreamForImport(lurl: Uml.LoadURL): \/[Set[Throwable], InputStream]

    Permalink

    Open an input stream on the external document to load

    Open an input stream on the external document to load

    lurl

    The LoadURL coordinates of the external document to load

    returns

    an input stream for reading the XMI contents of the external document to load

  11. implicit abstract val otiCharacteristicsProvider: OTICharacteristicsProvider[Uml]

    Permalink

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def addDocuments(ds: DocumentSet[Uml], d: Set[_ <: Document[Uml]]): \&/[Set[Throwable], DocumentSet[Uml]]

    Permalink

    Add a set of Documents to a DocumentSet

    Add a set of Documents to a DocumentSet

    Note that for performance reasons, the return type is Set[Throwable] \&/ DocumentSet[Uml] (fast merge) rather than the Set[Throwable] \&/ DocumentSet[Uml] (slow merge).

    ds

    DocumentSet

    d

    a set of Documents

    returns

    The DocumentSet resulting from adding each Document di in d where di can be successfully added.

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. def freezeMutableDocument(ds: DocumentSet[Uml], d: MutableDocument[Uml]): \/[Set[Throwable], (Document[Uml], DocumentSet[Uml])]

    Permalink
  11. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  12. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  15. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  16. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  17. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  18. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  19. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped