Packages

trait Expressions extends TypeExpression

A trait for inclusion into AST object in AST.scala

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Expressions
  2. TypeExpression
  3. AbstractDefinitions
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. trait Action extends RiddlValue

    Base class for all actions.

    Base class for all actions. Actions are used in the "then" and "but" clauses of a Gherkin example such as in the body of a handler's on clause or in the definition of a Function. The subclasses define different kinds of actions that can be used.

    Definition Classes
    AbstractDefinitions
  2. trait AlwaysEmpty extends Definition
    Definition Classes
    AbstractDefinitions
  3. case class BlockDescription(loc: At = At.empty, lines: Seq[LiteralString] = Seq.empty[LiteralString]) extends Description with Product with Serializable
    Definition Classes
    AbstractDefinitions
  4. trait BrieflyDescribedValue extends RiddlValue
    Definition Classes
    AbstractDefinitions
  5. trait Container[+D <: RiddlValue] extends RiddlValue

    Base trait of any definition that is also a ContainerValue

    Base trait of any definition that is also a ContainerValue

    D

    The kind of definition that is contained by the container

    Definition Classes
    AbstractDefinitions
  6. trait Definition extends DescribedValue with BrieflyDescribedValue with Container[Definition]

    Base trait for all definitions requiring an identifier for the definition and providing the identify method to yield a string that provides the kind and name

    Base trait for all definitions requiring an identifier for the definition and providing the identify method to yield a string that provides the kind and name

    Definition Classes
    AbstractDefinitions
  7. trait DescribedValue extends RiddlValue

    Base trait of all values that have an optional Description

    Base trait of all values that have an optional Description

    Definition Classes
    AbstractDefinitions
  8. trait Description extends RiddlValue

    The description of a definition.

    The description of a definition. All definitions have a name and an optional description. This class provides the description part.

    Definition Classes
    AbstractDefinitions
  9. case class FileDescription(loc: At, file: Path) extends Description with Product with Serializable
    Definition Classes
    AbstractDefinitions
  10. trait FunctionDefinition extends Definition

    Base trait of any definition that is in the content of a function.

    Base trait of any definition that is in the content of a function.

    Definition Classes
    AbstractDefinitions
  11. trait GherkinClause extends GherkinValue

    Base class of one of the four Gherkin clauses (Given, When, Then, But)

    Base class of one of the four Gherkin clauses (Given, When, Then, But)

    Definition Classes
    AbstractDefinitions
  12. trait GherkinValue extends RiddlValue

    Base class of any Gherkin value

    Base class of any Gherkin value

    Definition Classes
    AbstractDefinitions
  13. case class Identifier(loc: At, value: String) extends RiddlValue with Product with Serializable

    A RiddlValue that is a parsed identifier, typically the name of a definition.

    A RiddlValue that is a parsed identifier, typically the name of a definition.

    loc

    The location in the input where the identifier starts

    value

    The parsed value of the identifier

    Definition Classes
    AbstractDefinitions
  14. trait LeafDefinition extends Definition
    Definition Classes
    AbstractDefinitions
  15. case class LiteralString(loc: At, s: String) extends RiddlValue with Product with Serializable

    Represents a literal string parsed between quote characters in the input

    Represents a literal string parsed between quote characters in the input

    loc

    The location in the input of the opening quote character

    s

    The parsed value of the string content

    Definition Classes
    AbstractDefinitions
  16. case class PathIdentifier(loc: At, value: Seq[String]) extends RiddlValue with Product with Serializable

    Represents a segmented identifier to a definition in the model.

    Represents a segmented identifier to a definition in the model. Path Identifiers are parsed from a dot-separated list of identifiers in the input. Path identifiers are used to reference other definitions in the model.

    loc

    Location in the input of the first letter of the path identifier

    value

    The list of strings that make up the path identifier

    Definition Classes
    AbstractDefinitions
  17. trait ProjectionDefinition extends Definition

    Base trait of any definition that occurs in the body of a projection

    Base trait of any definition that occurs in the body of a projection

    Definition Classes
    AbstractDefinitions
  18. abstract class Reference[+T <: Definition] extends RiddlValue

    A reference to a definition of a specific type.

    A reference to a definition of a specific type.

    T

    The type of definition to which the references refers.

    Definition Classes
    AbstractDefinitions
  19. trait RiddlNode extends AnyRef

    The root trait of all things RIDDL AST.

    The root trait of all things RIDDL AST. Every node in the tree is a RiddlNode.

    Definition Classes
    AbstractDefinitions
  20. trait RiddlValue extends RiddlNode

    The root trait of all parsable values.

    The root trait of all parsable values. If a parser returns something, its a RiddlValue. The distinguishing factor is the inclusion of the parsing location given by the loc field.

    Definition Classes
    AbstractDefinitions
  21. trait SagaDefinition extends Definition

    Base trait of definitions that are part of a Saga Definition

    Base trait of definitions that are part of a Saga Definition

    Definition Classes
    AbstractDefinitions
  22. trait StateDefinition extends Definition

    Base trait of definitions that are part of a Saga Definition

    Base trait of definitions that are part of a Saga Definition

    Definition Classes
    AbstractDefinitions
  23. case class URLDescription(loc: At, url: URL) extends Description with Product with Serializable
    Definition Classes
    AbstractDefinitions
  24. case class AggregateConstructionExpression(loc: At, msg: Expressions.PathIdentifier, args: ArgList = ArgList()) extends Expression with Product with Serializable

    A helper class for creating aggregates and messages that represents the construction of the message or aggregate value from parameters

    A helper class for creating aggregates and messages that represents the construction of the message or aggregate value from parameters

    msg

    A message reference that specifies the specific type of message to construct

    args

    An argument list that should correspond to teh fields of the message

  25. case class AndCondition(loc: At, conditions: Seq[Condition]) extends MultiCondition with Product with Serializable

    And condition

    And condition

    loc

    Location of the and condition

    conditions

    The conditions (minimum 2) that must all be true for "and" to be true

  26. case class ArbitraryCondition(loc: At, cond: Expressions.LiteralString) extends Condition with Product with Serializable

    Represents an arbitrary condition that is specified merely with a literal string.

    Represents an arbitrary condition that is specified merely with a literal string. This can't be easily processed downstream but provides the author with the ability to include arbitrary ideas/concepts into an condition expression. For example in a when condition:

    example foo { when "the timer has expired" }

    shows the use of an arbitrary condition for the "when" part of a Gherkin example.

    cond

    The arbitrary condition provided as a quoted string

  27. case class ArbitraryExpression(cond: Expressions.LiteralString) extends Expression with Product with Serializable

    An arbitrary expression provided by a LiteralString Arbitrary expressions conform to the type based on the context in which they are found.

    An arbitrary expression provided by a LiteralString Arbitrary expressions conform to the type based on the context in which they are found. Another way to think of it is that arbitrary expressions are assignment compatible with any other type For example, in an arithmetic expression like this

    +(42,"number of widgets in a wack-a-mole")

    the arbitrary expression given by the string conforms to a numeric type since the context is the addition of 42 and the arbitrary expression

  28. case class ArbitraryOperator(loc: At, opName: Expressions.LiteralString, arguments: ArgList) extends Expression with Product with Serializable
  29. case class ArgList(args: ListMap[Expressions.Identifier, Expression] = ListMap
    .empty[Identifier, Expression]
    )
    extends RiddlNode with Product with Serializable

    The arguments of a FunctionCallExpression and AggregateConstructionExpression is a mapping between an argument name and the expression that provides the value for that argument.

    The arguments of a FunctionCallExpression and AggregateConstructionExpression is a mapping between an argument name and the expression that provides the value for that argument.

    args

    A mapping of Identifier to Expression to provide the arguments for the function call.

  30. case class ArithmeticOperator(loc: At, operator: String, operands: Seq[Expression]) extends NumericExpression with Product with Serializable

    Represents the use of an arithmetic operator or well-known function call.

    Represents the use of an arithmetic operator or well-known function call. The operator can be simple like addition or subtraction or complicated like pow, sqrt, etc. There is no limit on the number of operands but defining them shouldn't be necessary as they are pre-determined by use of the name of the operator (e.g. pow takes two floating point numbers, sqrt takes one.

    loc

    The location of the operator

    operator

    The name of the operator (+, -, sqrt, ...)

    operands

    A list of expressions that correspond to the required operands for the operator

  31. sealed trait Comparator extends RiddlNode
  32. case class Comparison(loc: At, op: Comparator, expr1: Expression, expr2: Expression) extends Condition with Product with Serializable

    Represents one of the six comparison operators

    Represents one of the six comparison operators

    loc

    Location of the comparison

    op

    The comparison operator

    expr1

    The first operand in the comparison

    expr2

    The second operand in the comparison

  33. sealed abstract class Condition extends Expression

    Base trait for expressions that yield a boolean value (a condition)

  34. case class DateFunction(loc: At, name: String, args: Seq[Expression] = Seq.empty[Expression]) extends ValueFunctionExpression with Product with Serializable
  35. sealed trait Expression extends RiddlValue

    Base trait of all expressions

  36. case class False(loc: At) extends Condition with Product with Serializable

    A condition value for "false"

    A condition value for "false"

    loc

    The location of this expression value

  37. case class FunctionCallCondition(loc: At, name: Expressions.PathIdentifier, arguments: ArgList) extends Condition with Product with Serializable

    A RIDDL Function call to the function identified by its path identifier with a matching set of arguments.

    A RIDDL Function call to the function identified by its path identifier with a matching set of arguments. This function must return a boolean since it is defined as a Condition.

    loc

    The location of the function call expression

    name

    The path identifier of the RIDDL Function being called

    arguments

    An ArgList to pass to the function.

  38. case class FunctionCallExpression(loc: At, name: Expressions.PathIdentifier, arguments: ArgList) extends Expression with Product with Serializable

    A RIDDL Function call.

    A RIDDL Function call. The only callable thing here is a function identified by its path identifier with a matching set of arguments

    loc

    The location of the function call expression

    name

    The path identifier of the RIDDL Function being called

    arguments

    An ArgList to pass to the function.

  39. case class GroupExpression(loc: At, expressions: Seq[Expression]) extends Expression with Product with Serializable

    A syntactic convenience for grouping a list of expressions.

    A syntactic convenience for grouping a list of expressions.

    loc

    The location of the expression group

    expressions

    The expressions that are grouped

  40. case class LiteralDecimal(loc: At, d: BigDecimal) extends NumericExpression with Product with Serializable

    An expression that is a liberal constant decimal value

    An expression that is a liberal constant decimal value

    loc

    The location of the decimal value

    d

    The decimal number to use as the value of the expression

  41. case class LiteralInteger(loc: At, n: BigInt) extends NumericExpression with Product with Serializable

    An expression that is a literal constant integer value

    An expression that is a literal constant integer value

    loc

    The location of the integer value

    n

    The number to use as the value of the expression

  42. abstract class MultiCondition extends Condition

    Base class for conditions with two operands

  43. case class NewEntityIdOperator(loc: At, entityId: Expressions.PathIdentifier) extends Expression with Product with Serializable

    A helper class for creating expressions that represent the creation of a new entity identifier for a specific kind of entity.

    A helper class for creating expressions that represent the creation of a new entity identifier for a specific kind of entity.

    loc

    The location of the expression in the source

    entityId

    The PathIdentifier of the entity type for with the Id is created

  44. case class NotCondition(loc: At, cond1: Condition) extends Condition with Product with Serializable

    Not condition

    Not condition

    loc

    Location of the not condition

    cond1

    The condition being negated

  45. case class NumberFunction(loc: At, name: String, args: Seq[Expression] = Seq.empty[Expression]) extends NumericExpression with ValueFunctionExpression with Product with Serializable
  46. sealed abstract class NumericExpression extends Expression

    Base trait for expressions that yield a numeric value

  47. case class OrCondition(loc: At, conditions: Seq[Condition]) extends MultiCondition with Product with Serializable

    Or condition

    Or condition

    loc

    Location of the or condition

    conditions

    The conditions (minimum 2), any one of which must be true for "Or" to be true

  48. case class StringFunction(loc: At, name: String, args: Seq[Expression] = Seq.empty[Expression]) extends ValueFunctionExpression with Product with Serializable
  49. case class Ternary(loc: At, condition: Condition, expr1: Expression, expr2: Expression) extends Expression with Product with Serializable

    Ternary operator to accept a conditional and two expressions and choose one of the expressions as the resulting value based on the conditional.

    Ternary operator to accept a conditional and two expressions and choose one of the expressions as the resulting value based on the conditional.

    loc

    The location of the ternary operator

    condition

    The conditional expression that determines the result

    expr1

    An expression for the result if the condition is true

    expr2

    An expression for the result if the condition is false

  50. case class TimeStampFunction(loc: At, name: String, args: Seq[Expression] = Seq.empty[Expression]) extends ValueFunctionExpression with Product with Serializable
  51. case class True(loc: At) extends Condition with Product with Serializable

    A condition value for "true"

    A condition value for "true"

    loc

    The location of this expression value

  52. case class UndefinedOperator(loc: At) extends Expression with Product with Serializable

    Represents a expression that will be specified later and uses the ??? syntax to represent that condition.

    Represents a expression that will be specified later and uses the ??? syntax to represent that condition.

    loc

    The location of the undefined condition

  53. case class ValueCondition(loc: At, path: Expressions.PathIdentifier) extends Condition with Product with Serializable

    Represents a condition that is merely a reference to some Boolean value, presumably an entity state value or parameter.

    Represents a condition that is merely a reference to some Boolean value, presumably an entity state value or parameter.

    loc

    The location of this condition

    path

    The path to the value for this condition

  54. trait ValueFunctionExpression extends Expression

    Base trait for expressions that yield a TimeStamp value

  55. case class ValueOperator(loc: At, path: Expressions.PathIdentifier) extends Expression with Product with Serializable

    Represents an opoerator that is merely a reference to some value, presumably an entity state value but could also be a projection or repository value.

    Represents an opoerator that is merely a reference to some value, presumably an entity state value but could also be a projection or repository value.

    loc

    The location of this expression

    path

    The path to the value for this expression

  56. case class XorCondition(loc: At, conditions: Seq[Condition]) extends MultiCondition with Product with Serializable

    Xor condition

    Xor condition

    loc

    Location of the xor condition

    conditions

    The conditions (minimum 2), only one of which may be true for "xor" to be true.

  57. case class Abstract(loc: At) extends PredefinedType with Product with Serializable

    The simplest type expression: Abstract An abstract type expression is one that is not defined explicitly.

    The simplest type expression: Abstract An abstract type expression is one that is not defined explicitly. It is treated as a concrete type but without any structural or type information. This is useful for types that are defined only at implementation time or for types whose variations are so complicated they need to remain abstract at the specification level.

    loc

    The location of the Bool type expression

    Definition Classes
    TypeExpression
  58. trait AggregateTypeExpression extends TypeExpression with Container[Field]

    A type expression that contains an aggregation of fields

    A type expression that contains an aggregation of fields

    This is used as the base trait of Aggregations and Messages

    Definition Classes
    TypeExpression
  59. sealed trait AggregateUseCase extends AnyRef

    Base of an enumeration for the four kinds of message types

    Base of an enumeration for the four kinds of message types

    Definition Classes
    TypeExpression
  60. case class AggregateUseCaseTypeExpression(loc: At, usecase: AggregateUseCase, fields: Seq[Field] = Seq.empty[Field]) extends AggregateTypeExpression with Product with Serializable

    A type expression for an aggregation that is marked as being one of the use cases.

    A type expression for an aggregation that is marked as being one of the use cases. This is used for messages, records, and other aggregate types that need to have their purpose distinguished.

    loc

    The location of the message type expression

    usecase

    The kind of message defined

    fields

    The fields of the message's aggregation

    Definition Classes
    TypeExpression
  61. case class Aggregation(loc: At, fields: Seq[Field] = Seq.empty[Field]) extends AggregateTypeExpression with Product with Serializable

    A type expression that takes a set of named fields as its value.

    A type expression that takes a set of named fields as its value.

    loc

    The location of the aggregation definition

    fields

    The fields of the aggregation

    Definition Classes
    TypeExpression
  62. case class AliasedTypeExpression(loc: At, pathId: TypeExpression.PathIdentifier) extends TypeExpression with Product with Serializable

    A TypeExpression that references another type by PathIdentifier

    A TypeExpression that references another type by PathIdentifier

    loc

    The location of the AliasedTypeExpression

    pathId

    The path identifier to the aliased type

    Definition Classes
    TypeExpression
  63. case class Alternation(loc: At, of: Seq[AliasedTypeExpression]) extends TypeExpression with Product with Serializable

    A type expression that that defines its range of possible values as being any one of the possible values from a set of other type expressions.

    A type expression that that defines its range of possible values as being any one of the possible values from a set of other type expressions.

    loc

    The location of the alternation type expression

    of

    The set of type expressions from which the value for this alternation may be chosen

    Definition Classes
    TypeExpression
  64. case class Bool(loc: At) extends PredefinedType with NumericType with Product with Serializable

    A predefined type expression for boolean values (true / false)

    A predefined type expression for boolean values (true / false)

    loc

    The location of the Bool type expression

    Definition Classes
    TypeExpression
  65. sealed trait Cardinality extends TypeExpression

    Base trait of the cardinality type expressions

    Base trait of the cardinality type expressions

    Definition Classes
    TypeExpression
  66. case class Currency(loc: At, country: String) extends PredefinedType with Product with Serializable
    Definition Classes
    TypeExpression
  67. case class Current(loc: At) extends PredefinedType with NumericType with Product with Serializable

    A predefined type expression for the SI Base unit for Current (amperes)

    A predefined type expression for the SI Base unit for Current (amperes)

    loc

    \- The locaitonof the current type expression

    Definition Classes
    TypeExpression
  68. case class Date(loc: At) extends PredefinedType with TimeType with Product with Serializable

    A predefined type expression for a calendar date.

    A predefined type expression for a calendar date.

    loc

    The location of the date type expression.

    Definition Classes
    TypeExpression
  69. case class DateTime(loc: At) extends PredefinedType with TimeType with Product with Serializable

    A predefined type expression for a calendar date and clock time combination.

    A predefined type expression for a calendar date and clock time combination.

    loc

    The location of the datetime type expression.

    Definition Classes
    TypeExpression
  70. case class Decimal(loc: At) extends PredefinedType with NumericType with Product with Serializable

    A predefined type expression for a decimal value including IEEE floating point syntax.

    A predefined type expression for a decimal value including IEEE floating point syntax.

    loc

    The location of the decimal integer type expression

    Definition Classes
    TypeExpression
  71. case class Duration(loc: At) extends PredefinedType with TimeType with Product with Serializable

    A predefined type expression for a time duration that records the number of milliseconds between two fixed points in time

    A predefined type expression for a time duration that records the number of milliseconds between two fixed points in time

    loc

    The location of the duration type expression

    Definition Classes
    TypeExpression
  72. case class EntityReferenceTypeExpression(loc: At, entity: TypeExpression.PathIdentifier) extends TypeExpression with Product with Serializable

    A type expression whose value is a reference to an instance of an entity.

    A type expression whose value is a reference to an instance of an entity.

    loc

    The location of the reference type expression

    entity

    The type of entity referenced by this type expression.

    Definition Classes
    TypeExpression
  73. case class Enumeration(loc: At, enumerators: Seq[Enumerator]) extends TypeExpression with Product with Serializable

    A type expression that defines its range of possible values as being one value from a set of enumerated values.

    A type expression that defines its range of possible values as being one value from a set of enumerated values.

    loc

    The location of the enumeration type expression

    enumerators

    The set of enumerators from which the value of this enumeration may be chosen.

    Definition Classes
    TypeExpression
  74. case class Enumerator(loc: At, id: TypeExpression.Identifier, enumVal: Option[Long] = None, brief: Option[TypeExpression.LiteralString] = Option.empty[LiteralString], description: Option[TypeExpression.Description] = None) extends LeafDefinition with TypeDefinition with Product with Serializable

    Represents one variant among (one or) many variants that comprise an Enumeration

    Represents one variant among (one or) many variants that comprise an Enumeration

    id

    the identifier (name) of the Enumerator

    enumVal

    the optional int value

    brief

    A brief description (one sentence) for use in documentation

    description

    the description of the enumerator. Each Enumerator in an enumeration may define independent descriptions

    Definition Classes
    TypeExpression
  75. case class Field(loc: At, id: TypeExpression.Identifier, typeEx: TypeExpression, brief: Option[TypeExpression.LiteralString] = Option.empty[LiteralString], description: Option[TypeExpression.Description] = None) extends LeafDefinition with AlwaysEmpty with TypeDefinition with SagaDefinition with StateDefinition with FunctionDefinition with ProjectionDefinition with Product with Serializable

    A definition that is a field of an aggregation type expressions.

    A definition that is a field of an aggregation type expressions. Fields associate an identifier with a type expression.

    loc

    The location of the field definition

    id

    The name of the field

    typeEx

    The type of the field

    brief

    A brief description (one sentence) for use in documentation

    description

    An optional description of the field.

    Definition Classes
    TypeExpression
  76. case class Integer(loc: At) extends PredefinedType with NumericType with Product with Serializable

    A predefined type expression for an integer value

    A predefined type expression for an integer value

    loc

    The location of the integer type expression

    Definition Classes
    TypeExpression
  77. case class Length(loc: At) extends PredefinedType with NumericType with Product with Serializable

    A predefined type expression for the SI Base unit for Length (meters)

    A predefined type expression for the SI Base unit for Length (meters)

    loc

    The location of the current type expression

    Definition Classes
    TypeExpression
  78. case class Location(loc: At) extends PredefinedType with Product with Serializable

    A predefined type expression for a location on earth given in latitude and longitude.

    A predefined type expression for a location on earth given in latitude and longitude.

    loc

    The location of the LatLong type expression.

    Definition Classes
    TypeExpression
  79. case class Luminosity(loc: At) extends PredefinedType with NumericType with Product with Serializable

    A predefined type expression for the SI Base Unit for Luminosity (candela)

    A predefined type expression for the SI Base Unit for Luminosity (candela)

    loc

    The location of the luminosity expression

    Definition Classes
    TypeExpression
  80. case class Mapping(loc: At, from: TypeExpression, to: TypeExpression) extends TypeExpression with Product with Serializable

    A type expressions that defines a mapping from a key to a value.

    A type expressions that defines a mapping from a key to a value. The value of a Mapping is the set of mapped key -> value pairs, based on which keys have been provided values.

    loc

    The location of the mapping type expression

    from

    The type expression for the keys of the mapping

    to

    The type expression for the values of the mapping

    Definition Classes
    TypeExpression
  81. case class Mass(loc: At) extends PredefinedType with NumericType with Product with Serializable
    Definition Classes
    TypeExpression
  82. case class Mole(loc: At) extends PredefinedType with NumericType with Product with Serializable

    A predefined type expression for the SI Base Unit for Mole (mole)

    A predefined type expression for the SI Base Unit for Mole (mole)

    loc

    \- The location of the mass type expression

    Definition Classes
    TypeExpression
  83. case class Nothing(loc: At) extends PredefinedType with Product with Serializable

    A predefined type expression for a type that can have no values

    A predefined type expression for a type that can have no values

    loc

    The location of the nothing type expression.

    Definition Classes
    TypeExpression
  84. case class Number(loc: At) extends PredefinedType with NumericType with Product with Serializable

    A predefined type expression for an arbitrary number value

    A predefined type expression for an arbitrary number value

    loc

    The location of the number type expression

    Definition Classes
    TypeExpression
  85. sealed trait NumericType extends PredefinedType
    Definition Classes
    TypeExpression
  86. case class OneOrMore(loc: At, typeExp: TypeExpression) extends Cardinality with Product with Serializable

    A cardinality type expression that indicates another type expression as having one or more instances.

    A cardinality type expression that indicates another type expression as having one or more instances.

    loc

    The location of the one-or-more cardinality

    typeExp

    The type expression that is indicated with a cardinality of one or more.

    Definition Classes
    TypeExpression
  87. case class Optional(loc: At, typeExp: TypeExpression) extends Cardinality with Product with Serializable

    A cardinality type expression that indicates another type expression as being optional; that is with a cardinality of 0 or 1.

    A cardinality type expression that indicates another type expression as being optional; that is with a cardinality of 0 or 1.

    loc

    The location of the optional cardinality

    typeExp

    The type expression that is indicated as optional

    Definition Classes
    TypeExpression
  88. case class Pattern(loc: At, pattern: Seq[TypeExpression.LiteralString]) extends PredefinedType with Product with Serializable

    A type expression that defines a string value constrained by a Java Regular Expression

    A type expression that defines a string value constrained by a Java Regular Expression

    loc

    The location of the pattern type expression

    pattern

    The Java Regular Expression to which values of this type expression must obey.

    Definition Classes
    TypeExpression
    See also

    https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/regex/Pattern.html

  89. abstract class PredefinedType extends TypeExpression

    Base class of all pre-defined type expressions

    Base class of all pre-defined type expressions

    Definition Classes
    TypeExpression
  90. case class RangeType(loc: At, min: Long, max: Long) extends PredefinedType with NumericType with Product with Serializable

    A type expression that defines a set of integer values from a minimum value to a maximum value, inclusively.

    A type expression that defines a set of integer values from a minimum value to a maximum value, inclusively.

    loc

    The location of the RangeType type expression

    min

    The minimum value of the RangeType

    max

    The maximum value of the RangeType

    Definition Classes
    TypeExpression
  91. case class Real(loc: At) extends PredefinedType with NumericType with Product with Serializable

    A predefined type expression for a real number value.

    A predefined type expression for a real number value.

    loc

    The location of the real number type expression

    Definition Classes
    TypeExpression
  92. case class SpecificRange(loc: At, typeExp: TypeExpression, min: Long, max: Long) extends Cardinality with Product with Serializable

    A cardinality type expression that indicates another type expression as having a specific range of instances

    A cardinality type expression that indicates another type expression as having a specific range of instances

    loc

    The location of the one-or-more cardinality

    typeExp

    The type expression that is indicated with a cardinality of one or more.

    min

    The minimum number of items

    max

    The maximum number of items

    Definition Classes
    TypeExpression
  93. case class Strng(loc: At, min: Option[Long] = None, max: Option[Long] = None) extends PredefinedType with Product with Serializable

    A type expression for values of arbitrary string type, possibly bounded by length.

    A type expression for values of arbitrary string type, possibly bounded by length.

    loc

    The location of the Strng type expression

    min

    The minimum length of the string (default: 0)

    max

    The maximum length of the string (default: MaxInt)

    Definition Classes
    TypeExpression
  94. case class Temperature(loc: At) extends PredefinedType with NumericType with Product with Serializable

    A predefined type expression for the SI Base Unit for Temperature (Kelvin)

    A predefined type expression for the SI Base Unit for Temperature (Kelvin)

    loc

    \- The location of the mass type expression

    Definition Classes
    TypeExpression
  95. case class Time(loc: At) extends PredefinedType with TimeType with Product with Serializable

    A predefined type expression for a clock time with hours, minutes, seconds.

    A predefined type expression for a clock time with hours, minutes, seconds.

    loc

    The location of the time type expression.

    Definition Classes
    TypeExpression
  96. case class TimeStamp(loc: At) extends PredefinedType with TimeType with Product with Serializable

    A predefined type expression for a timestamp that records the number of milliseconds from the epoch.

    A predefined type expression for a timestamp that records the number of milliseconds from the epoch.

    loc

    The location of the timestamp

    Definition Classes
    TypeExpression
  97. sealed trait TimeType extends PredefinedType
    Definition Classes
    TypeExpression
  98. sealed trait TypeDefinition extends Definition
    Definition Classes
    TypeExpression
  99. sealed trait TypeExpression extends RiddlValue

    Base trait of an expression that defines a type

    Base trait of an expression that defines a type

    Definition Classes
    TypeExpression
  100. case class URL(loc: At, scheme: Option[TypeExpression.LiteralString] = None) extends PredefinedType with Product with Serializable

    A predefined type expression for a Uniform Resource Locator of a specific schema.

    A predefined type expression for a Uniform Resource Locator of a specific schema.

    loc

    The location of the URL type expression

    scheme

    The scheme to which the URL is constrained.

    Definition Classes
    TypeExpression
  101. case class UUID(loc: At) extends PredefinedType with Product with Serializable

    A predefined type expression for a universally unique identifier as defined by the Java Virtual Machine.

    A predefined type expression for a universally unique identifier as defined by the Java Virtual Machine.

    loc

    The location of the UUID type expression

    Definition Classes
    TypeExpression
  102. case class UniqueId(loc: At, entityPath: TypeExpression.PathIdentifier) extends PredefinedType with Product with Serializable

    A type expression for values that ensure a unique identifier for a specific entity.

    A type expression for values that ensure a unique identifier for a specific entity.

    loc

    The location of the unique identifier type expression

    entityPath

    The path identifier of the entity type

    Definition Classes
    TypeExpression
  103. case class ZeroOrMore(loc: At, typeExp: TypeExpression) extends Cardinality with Product with Serializable

    A cardinality type expression that indicates another type expression as having zero or more instances.

    A cardinality type expression that indicates another type expression as having zero or more instances.

    loc

    The location of the zero-or-more cardinality

    typeExp

    The type expression that is indicated with a cardinality of zero or more.

    Definition Classes
    TypeExpression

Value Members

  1. object Identifier extends Serializable
    Definition Classes
    AbstractDefinitions
  2. object LiteralString extends Serializable
    Definition Classes
    AbstractDefinitions
  3. object PathIdentifier extends Serializable
    Definition Classes
    AbstractDefinitions
  4. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. final def ##: Int
    Definition Classes
    AnyRef → Any
  6. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  11. def errorDescription(te: TypeExpression): String

    A utility function for getting the kind of a type expression.

    A utility function for getting the kind of a type expression.

    te

    The type expression to examine

    returns

    A string indicating the kind corresponding to te

    Definition Classes
    TypeExpression
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  18. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  19. def toString(): String
    Definition Classes
    AnyRef → Any
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. case object eq extends Comparator with Product with Serializable
  24. case object ge extends Comparator with Product with Serializable
  25. case object gt extends Comparator with Product with Serializable
  26. case object le extends Comparator with Product with Serializable
  27. case object lt extends Comparator with Product with Serializable
  28. case object ne extends Comparator with Product with Serializable
  29. object Aggregation extends Serializable
    Definition Classes
    TypeExpression
  30. case object CommandCase extends AggregateUseCase with Product with Serializable

    An enumerator value for command types

    An enumerator value for command types

    Definition Classes
    TypeExpression
  31. case object EventCase extends AggregateUseCase with Product with Serializable

    An enumerator value for event types

    An enumerator value for event types

    Definition Classes
    TypeExpression
  32. case object OtherCase extends AggregateUseCase with Product with Serializable
    Definition Classes
    TypeExpression
  33. object PredefinedType
    Definition Classes
    TypeExpression
  34. case object QueryCase extends AggregateUseCase with Product with Serializable

    An enumerator value for query types

    An enumerator value for query types

    Definition Classes
    TypeExpression
  35. case object RecordCase extends AggregateUseCase with Product with Serializable
    Definition Classes
    TypeExpression
  36. case object ResultCase extends AggregateUseCase with Product with Serializable

    An enumerator value for result types

    An enumerator value for result types

    Definition Classes
    TypeExpression

Deprecated Value Members

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

Inherited from ast.TypeExpression

Inherited from AbstractDefinitions

Inherited from AnyRef

Inherited from Any

Ungrouped