case class Application(loc: At, id: Definitions.Identifier, options: Seq[Definitions.ApplicationOption] = Seq.empty[ApplicationOption], types: Seq[Type] = Seq.empty[Type], groups: Seq[Group] = Seq.empty[Group], handlers: Seq[Handler] = Seq.empty[Handler], inlets: Seq[Inlet] = Seq.empty[Inlet], outlets: Seq[Outlet] = Seq.empty[Outlet], authors: Seq[AuthorRef] = Seq.empty[AuthorRef], terms: Seq[Term] = Seq.empty[Term], includes: Seq[Include[ApplicationDefinition]] = Seq.empty, brief: Option[Definitions.LiteralString] = None, description: Option[Definitions.Description] = None) extends Processor[ApplicationOption, ApplicationDefinition] with DomainDefinition with Product with Serializable
An application from which a person, robot, or other active agent (the user) will obtain information, or to which that user will provided information.
- loc
The location of the application in the source
- id
The unique identifier for the application
- options
The options for the application
- types
Types that are needed for the communication with the user
- groups
A list of group definitions needed by the application
- handlers
The handlers for this application to process incoming messages
- inlets
Message inlets for the application
- outlets
Message outlets for the application
- authors
Author definitions for the application, for attribution of application components.
- terms
Definitions of terms useful in comprehending the application's purpose
- includes
Included source code
- brief
A brief description of the application
- description
A longer description of the application.
- Alphabetic
- By Inheritance
- Application
- Serializable
- Product
- Equals
- DomainDefinition
- Processor
- WithTypes
- VitalDefinition
- WithTerms
- WithIncludes
- WithAuthors
- WithOptions
- Definition
- Container
- BrieflyDescribedValue
- DescribedValue
- RiddlValue
- RiddlNode
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Application(loc: At, id: Definitions.Identifier, options: Seq[Definitions.ApplicationOption] = Seq.empty[ApplicationOption], types: Seq[Type] = Seq.empty[Type], groups: Seq[Group] = Seq.empty[Group], handlers: Seq[Handler] = Seq.empty[Handler], inlets: Seq[Inlet] = Seq.empty[Inlet], outlets: Seq[Outlet] = Seq.empty[Outlet], authors: Seq[AuthorRef] = Seq.empty[AuthorRef], terms: Seq[Term] = Seq.empty[Term], includes: Seq[Include[ApplicationDefinition]] = Seq.empty, brief: Option[Definitions.LiteralString] = None, description: Option[Definitions.Description] = None)
- loc
The location of the application in the source
- id
The unique identifier for the application
- options
The options for the application
- types
Types that are needed for the communication with the user
- groups
A list of group definitions needed by the application
- handlers
The handlers for this application to process incoming messages
- inlets
Message inlets for the application
- outlets
Message outlets for the application
- authors
Author definitions for the application, for attribution of application components.
- terms
Definitions of terms useful in comprehending the application's purpose
- includes
Included source code
- brief
A brief description of the application
- description
A longer description of the application.
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val authors: Seq[AuthorRef]
- Definition Classes
- Application → WithAuthors
- implicit def bool2int(b: Boolean): Int
Implicit conversion of boolean to Int for easier computation of statistics below
Implicit conversion of boolean to Int for easier computation of statistics below
- b
The boolean to convert to an Int
- Definition Classes
- VitalDefinition
- val brief: Option[Definitions.LiteralString]
- Definition Classes
- Application → BrieflyDescribedValue
- def briefValue: String
- Definition Classes
- BrieflyDescribedValue
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
- def completeness: (Int, Int)
Compute the completeness of this definition.
Compute the completeness of this definition. Vital definitions should have options, terms, and authors but includes are optional. Incompleteness is signalled by child definitions that are empty.
- returns
A numerator and denominator for percent complete
- Definition Classes
- VitalDefinition
- lazy val contents: Seq[ApplicationDefinition]
- Definition Classes
- Application → WithIncludes → Container
- val description: Option[Definitions.Description]
- Definition Classes
- Application → DescribedValue
- def descriptionValue: String
- Definition Classes
- DescribedValue
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def find(name: String): Option[Definitions.Definition]
- Definition Classes
- Definition
- def format: String
Format the node to a string
Format the node to a string
- Definition Classes
- WithOptions → RiddlNode
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- def getOptionValue[OPT <: Definitions.ApplicationOption](implicit arg0: ClassTag[OPT]): Option[Seq[Definitions.LiteralString]]
- Definition Classes
- WithOptions
- val groups: Seq[Group]
- val handlers: Seq[Handler]
- Definition Classes
- Application → Processor
- def hasAuthors: Boolean
- Definition Classes
- WithAuthors → Definition
- def hasInlets: Boolean
- Definition Classes
- Processor
- def hasOption[OPT <: Definitions.ApplicationOption](implicit arg0: ClassTag[OPT]): Boolean
- Definition Classes
- WithOptions
- def hasOptions: Boolean
- Definition Classes
- WithOptions → Definition
- def hasOutlets: Boolean
- Definition Classes
- Processor
- def hasTerms: Boolean
- Definition Classes
- WithTerms
- def hasTypes: Boolean
- Definition Classes
- WithTypes → Definition
- val id: Definitions.Identifier
- Definition Classes
- Application → Definition
- def identify: String
- Definition Classes
- Definition
- def identifyWithLoc: String
- Definition Classes
- Definition
- val includes: Seq[Include[ApplicationDefinition]]
- Definition Classes
- Application → WithIncludes
- val inlets: Seq[Inlet]
- Definition Classes
- Application → Processor
- def isContainer: Boolean
Determine if this node is a container or not
- def isEmpty: Boolean
determine if this node is empty or not.
determine if this node is empty or not. Non-containers are always empty
- Definition Classes
- WithOptions → Container → RiddlNode
- def isImplicit: Boolean
- Definition Classes
- Definition
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isRootContainer: Boolean
- Definition Classes
- Container
- def isVital: Boolean
- Definition Classes
- VitalDefinition → Definition
- def kind: String
- Definition Classes
- Application → Definition
- val loc: At
The location in the parse at which this RiddlValue occurs
The location in the parse at which this RiddlValue occurs
- Definition Classes
- Application → RiddlValue
- def maturity: Int
Compute the 'maturity' of a definition.
Compute the 'maturity' of a definition. Maturity is a score with no maximum but with scoring rules that target 100 points per definition. Maturity is broken down this way:
- has a description - up to 50 points depending on # of non empty lines
- has a brief description - 5 points
- has options specified - 5 points
- has terms defined -
- has an author in or above the definition - 5 points \-
- definition specific things: 0.65
- Definition Classes
- VitalDefinition
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def nonEmpty: Boolean
- Definition Classes
- RiddlNode
- Annotations
- @deprecatedOverriding()
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- val options: Seq[Definitions.ApplicationOption]
- Definition Classes
- Application → WithOptions
- val outlets: Seq[Outlet]
- Definition Classes
- Application → Processor
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val terms: Seq[Term]
- Definition Classes
- Application → WithTerms
- val types: Seq[Type]
- Definition Classes
- Application → WithTypes
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated