Packages

case class Domain(loc: Location, id: Identifier, author: Option[AuthorInfo] = Option.empty[AuthorInfo], types: Seq[Type] = Seq.empty[Type], contexts: Seq[Context] = Seq.empty[Context], plants: Seq[Plant] = Seq.empty[Plant], stories: Seq[Story] = Seq.empty[Story], domains: Seq[Domain] = Seq.empty[Domain], terms: Seq[Term] = Seq.empty[Term], includes: Seq[Include] = Seq.empty[Include], brief: Option[LiteralString] = Option.empty[LiteralString], description: Option[Description] = None) extends ParentDefOf[DomainDefinition] with DomainDefinition with WithIncludes with WithTerms with Product with Serializable

The definition of a domain. Domains are the highest building block in RIDDL and may be nested inside each other to form a hierarchy of domains. Generally, domains follow hierarchical organization structure but other taxonomies and ontologies may be modelled with domains too.

loc

The location of the domain definition

id

The name of the domain

types

The types defined in the scope of the domain

contexts

The contexts defined in the scope of the domain

plants

The plants defined in the scope of the domain

domains

Nested sub-domains within this domain

terms

Definition of terms pertaining to this domain that provide explanation of concepts from the domain.

brief

A brief description (one sentence) for use in documentation

description

An optional description of the domain.

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Domain
  2. Serializable
  3. Product
  4. Equals
  5. WithTerms
  6. WithIncludes
  7. DomainDefinition
  8. ParentDefOf
  9. Container
  10. Definition
  11. BrieflyDescribedValue
  12. DescribedValue
  13. RiddlValue
  14. RiddlNode
  15. AnyRef
  16. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Domain(loc: Location, id: Identifier, author: Option[AuthorInfo] = Option.empty[AuthorInfo], types: Seq[Type] = Seq.empty[Type], contexts: Seq[Context] = Seq.empty[Context], plants: Seq[Plant] = Seq.empty[Plant], stories: Seq[Story] = Seq.empty[Story], domains: Seq[Domain] = Seq.empty[Domain], terms: Seq[Term] = Seq.empty[Term], includes: Seq[Include] = Seq.empty[Include], brief: Option[LiteralString] = Option.empty[LiteralString], description: Option[Description] = None)

    loc

    The location of the domain definition

    id

    The name of the domain

    types

    The types defined in the scope of the domain

    contexts

    The contexts defined in the scope of the domain

    plants

    The plants defined in the scope of the domain

    domains

    Nested sub-domains within this domain

    terms

    Definition of terms pertaining to this domain that provide explanation of concepts from the domain.

    brief

    A brief description (one sentence) for use in documentation

    description

    An optional description of the domain.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. val author: Option[AuthorInfo]
  6. val brief: Option[LiteralString]
    Definition Classes
    DomainBrieflyDescribedValue
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  8. def contents: Seq[DomainDefinition]
    Definition Classes
    DomainContainer
  9. val contexts: Seq[Context]
  10. val description: Option[Description]
    Definition Classes
    DomainDescribedValue
  11. val domains: Seq[Domain]
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def format: String
    Definition Classes
    RiddlNode
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  15. val id: Identifier
    Definition Classes
    DomainDefinition
  16. def identify: String
    Definition Classes
    Definition
  17. def identifyWithLoc: String
    Definition Classes
    Definition
  18. val includes: Seq[Include]
    Definition Classes
    DomainWithIncludes
  19. def isContainer: Boolean
    Definition Classes
    ContainerRiddlValue
  20. def isEmpty: Boolean
    Definition Classes
    DomainContainerRiddlNode
  21. def isImplicit: Boolean
    Definition Classes
    Definition
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. def isRootContainer: Boolean
    Definition Classes
    Container
  24. def kind: String
    Definition Classes
    Definition
  25. def kindId: String
    Definition Classes
    Definition
  26. val loc: Location
    Definition Classes
    DomainRiddlValue
  27. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. def nonEmpty: Boolean
    Definition Classes
    RiddlNode
    Annotations
    @deprecatedOverriding()
  29. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  30. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  31. val plants: Seq[Plant]
  32. def productElementNames: Iterator[String]
    Definition Classes
    Product
  33. val stories: Seq[Story]
  34. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  35. val terms: Seq[Term]
    Definition Classes
    DomainWithTerms
  36. val types: Seq[Type]
  37. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  38. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  39. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from WithTerms

Inherited from WithIncludes

Inherited from DomainDefinition

Inherited from Container[DomainDefinition]

Inherited from Definition

Inherited from BrieflyDescribedValue

Inherited from DescribedValue

Inherited from RiddlValue

Inherited from RiddlNode

Inherited from AnyRef

Inherited from Any

Ungrouped