Packages

trait Processor[OPT <: OptionValue, DEF <: Definition] extends VitalDefinition[OPT, DEF] with WithTypes

Definition of a Processor. This is a base class for all Processor definitions (things that have inlets, outlets, handlers, and take messages directly with a reference).

Linear Supertypes
WithTypes, VitalDefinition[OPT, DEF], WithTerms, WithIncludes[DEF], WithAuthors, Definitions.WithOptions[OPT], Definitions.Definition, Definitions.Container[DEF], Definitions.BrieflyDescribedValue, Definitions.DescribedValue, Definitions.RiddlValue, Definitions.RiddlNode, AnyRef, Any
Known Subclasses
Adaptor, Application, Context, Entity, Projection, Repository, Streamlet
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Processor
  2. WithTypes
  3. VitalDefinition
  4. WithTerms
  5. WithIncludes
  6. WithAuthors
  7. WithOptions
  8. Definition
  9. Container
  10. BrieflyDescribedValue
  11. DescribedValue
  12. RiddlValue
  13. RiddlNode
  14. AnyRef
  15. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def authors: Seq[AuthorRef]
    Definition Classes
    WithAuthors
  2. abstract def brief: Option[Definitions.LiteralString]
    Definition Classes
    BrieflyDescribedValue
  3. abstract def description: Option[Definitions.Description]
    Definition Classes
    DescribedValue
  4. abstract def handlers: Seq[Handler]
  5. abstract def id: Definitions.Identifier
    Definition Classes
    Definition
  6. abstract def includes: Seq[Include[DEF]]
    Definition Classes
    WithIncludes
  7. abstract def inlets: Seq[Inlet]
  8. abstract def kind: String
    Definition Classes
    Definition
  9. abstract def loc: At

    The location in the parse at which this RiddlValue occurs

    The location in the parse at which this RiddlValue occurs

    Definition Classes
    RiddlValue
  10. abstract def options: Seq[OPT]
    Definition Classes
    WithOptions
  11. abstract def outlets: Seq[Outlet]
  12. abstract def terms: Seq[Term]
    Definition Classes
    WithTerms
  13. abstract def types: Seq[Type]
    Definition Classes
    WithTypes

Concrete 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. 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
  6. def briefValue: String
    Definition Classes
    BrieflyDescribedValue
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  8. 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
  9. def contents: Seq[DEF]
    Definition Classes
    WithIncludes → Container
  10. def descriptionValue: String
    Definition Classes
    DescribedValue
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  13. def find(name: String): Option[Definitions.Definition]
    Definition Classes
    Definition
  14. def format: String

    Format the node to a string

    Format the node to a string

    Definition Classes
    WithOptions → RiddlNode
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  16. def getOptionValue[OPT <: OPT](implicit arg0: ClassTag[OPT]): Option[Seq[Definitions.LiteralString]]
    Definition Classes
    WithOptions
  17. def hasAuthors: Boolean
    Definition Classes
    WithAuthors → Definition
  18. def hasInlets: Boolean
  19. def hasOption[OPT <: OPT](implicit arg0: ClassTag[OPT]): Boolean
    Definition Classes
    WithOptions
  20. def hasOptions: Boolean
    Definition Classes
    WithOptions → Definition
  21. def hasOutlets: Boolean
  22. def hasTerms: Boolean
    Definition Classes
    WithTerms
  23. def hasTypes: Boolean
    Definition Classes
    WithTypes → Definition
  24. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  25. def identify: String
    Definition Classes
    Definition
  26. def identifyWithLoc: String
    Definition Classes
    Definition
  27. def isContainer: Boolean

    Determine if this node is a container or not

    Determine if this node is a container or not

    Definition Classes
    Container → RiddlNode
  28. 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
  29. def isImplicit: Boolean
    Definition Classes
    Definition
  30. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  31. def isRootContainer: Boolean
    Definition Classes
    Container
  32. def isVital: Boolean
    Definition Classes
    VitalDefinition → Definition
  33. 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
  34. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  35. final def nonEmpty: Boolean
    Definition Classes
    RiddlNode
    Annotations
    @deprecatedOverriding()
  36. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  37. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  38. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  39. def toString(): String
    Definition Classes
    AnyRef → Any
  40. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  41. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  42. 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 WithTypes

Inherited from VitalDefinition[OPT, DEF]

Inherited from WithTerms

Inherited from WithIncludes[DEF]

Inherited from WithAuthors

Inherited from Definitions.WithOptions[OPT]

Inherited from Definitions.Definition

Inherited from Definitions.Container[DEF]

Inherited from Definitions.BrieflyDescribedValue

Inherited from Definitions.DescribedValue

Inherited from Definitions.RiddlValue

Inherited from Definitions.RiddlNode

Inherited from AnyRef

Inherited from Any

Ungrouped