Class

org.apache.daffodil.dsom

DFDLDefineVariable

Related Doc: package dsom

Permalink

class DFDLDefineVariable extends DFDLDefiningAnnotation

Linear Supertypes
DFDLDefiningAnnotation, GlobalNonElementComponentMixin, GlobalComponent, PrefixAndNamespaceMixin, NamedMixin, DFDLAnnotation, FindPropertyMixin, NestingLexicalMixin, SchemaComponent, PropTypes, SchemaFileLocatableImpl, SchemaFileLocatable, HasSchemaFileLocation, LookupLocation, LocationInSchemaFile, ResolvesQNames, SchemaComponentIncludesAndImportsMixin, CommonContextMixin, NestingMixin, GetAttributesMixin, ImplementsThrowsOrSavesSDE, SavesErrorsAndWarnings, ImplementsThrowsSDE, ThrowsSDE, OOLAGHost, NamedMixinBase, WithDiagnostics, Logging, Identity, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DFDLDefineVariable
  2. DFDLDefiningAnnotation
  3. GlobalNonElementComponentMixin
  4. GlobalComponent
  5. PrefixAndNamespaceMixin
  6. NamedMixin
  7. DFDLAnnotation
  8. FindPropertyMixin
  9. NestingLexicalMixin
  10. SchemaComponent
  11. PropTypes
  12. SchemaFileLocatableImpl
  13. SchemaFileLocatable
  14. HasSchemaFileLocation
  15. LookupLocation
  16. LocationInSchemaFile
  17. ResolvesQNames
  18. SchemaComponentIncludesAndImportsMixin
  19. CommonContextMixin
  20. NestingMixin
  21. GetAttributesMixin
  22. ImplementsThrowsOrSavesSDE
  23. SavesErrorsAndWarnings
  24. ImplementsThrowsSDE
  25. ThrowsSDE
  26. OOLAGHost
  27. NamedMixinBase
  28. WithDiagnostics
  29. Logging
  30. Identity
  31. AnyRef
  32. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DFDLDefineVariable(node: Node, doc: SchemaDocument)

    Permalink

Type Members

  1. type PropItem = (String, (String, LookupLocation))

    Permalink
    Definition Classes
    PropTypes
  2. type PropMap = Map[String, (String, LookupLocation)]

    Permalink
    Definition Classes
    PropTypes

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. final def LV[T](sym: Symbol)(body: ⇒ T): OOLAGValue[T]

    Permalink
    Attributes
    protected
    Definition Classes
    OOLAGHost
  5. def NoAnnotationContext: Option[SchemaFileLocation]

    Permalink
    Definition Classes
    ImplementsThrowsSDE
  6. def SDE(id: String, args: Any*): Nothing

    Permalink
    Definition Classes
    ImplementsThrowsSDE → ThrowsSDE
  7. final def SDE(th: Throwable): Nothing

    Permalink
    Definition Classes
    ThrowsSDE
  8. def SDEButContinue(id: String, args: Any*): Unit

    Permalink
    Definition Classes
    ImplementsThrowsOrSavesSDE → SavesErrorsAndWarnings
  9. def SDW(warnID: WarnID, fmt: String, args: Any*): Unit

    Permalink
    Definition Classes
    ImplementsThrowsOrSavesSDE → SavesErrorsAndWarnings
  10. def ThrowSDE: PartialFunction[Throwable, Nothing]

    Permalink
    Definition Classes
    ThrowsSDE
  11. final lazy val annotatedSC: AnnotatedSchemaComponent

    Permalink
    Definition Classes
    DFDLAnnotation
  12. final def areLogging(lvl: Type): Boolean

    Permalink
    Definition Classes
    Logging
  13. final lazy val asAnnotation: DFDLDefiningAnnotation with DFDLAnnotation

    Permalink
    Definition Classes
    DFDLDefiningAnnotation
  14. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  15. final def assuming(pred: Boolean): Unit

    Permalink
    Definition Classes
    OOLAGHost
  16. final def cacheGetPropertyOption(name: String): Option[String]

    Permalink
    Attributes
    protected
    Definition Classes
    FindPropertyMixin
  17. final def cacheProperty(name: String): Found

    Permalink
    Attributes
    protected
    Definition Classes
    FindPropertyMixin
  18. final def cachePropertyOption(name: String): PropertyLookupResult

    Permalink
    Attributes
    protected
    Definition Classes
    FindPropertyMixin
  19. final def checkErrors: Unit

    Permalink
    Definition Classes
    OOLAGHost
  20. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final lazy val columnAttribute: Option[String]

    Permalink
    Definition Classes
    SchemaFileLocatableImpl → SchemaFileLocatable
  22. lazy val columnDescription: String

    Permalink
    Definition Classes
    SchemaFileLocatable → HasSchemaFileLocation → LocationInSchemaFile
  23. lazy val columnNumber: Option[String]

    Permalink
    Definition Classes
    SchemaFileLocatable
  24. final val context: AnnotatedSchemaComponent

    Permalink
    Definition Classes
    DFDLAnnotationSchemaComponent
  25. final var currentOVList: Seq[OOLAGValueBase]

    Permalink
    Definition Classes
    OOLAGHost
  26. def dafAttributes(n: Node): MetaData

    Permalink
    Definition Classes
    GetAttributesMixin
  27. final lazy val defaultValue: Option[String]

    Permalink
  28. def dfdlAttributes(n: Node): MetaData

    Permalink
    Definition Classes
    GetAttributesMixin
  29. lazy val diagnosticDebugName: String

    Permalink
    Definition Classes
    NamedMixin → NamedMixinBase
  30. def diagnostics: Seq[Diagnostic]

    Permalink
    Definition Classes
    OOLAGHost
  31. def doLogging(lvl: Type, msg: String, args: Seq[Any]): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  32. lazy val dpathCompileInfo: DPathCompileInfo

    Permalink
    Definition Classes
    SchemaComponent
  33. val emptyPropMap: PropMap

    Permalink
    Definition Classes
    PropTypes
  34. final lazy val enclosingComponent: Option[SchemaComponent]

    Permalink

    The enclosing component, and follows back-references from types to their elements, from globalElementDef to elementRefs, from simpleType defs to derived simpletype defs, from global group defs to group refs

    The enclosing component, and follows back-references from types to their elements, from globalElementDef to elementRefs, from simpleType defs to derived simpletype defs, from global group defs to group refs

    Note: the enclosing component of a global element or global group referenced from a element ref or group ref, is NOT the ref object, but the component that contains the ref object

    Definition Classes
    NestingMixin
  35. def enclosingComponentDef: Option[SchemaComponent]

    Permalink

    Define this for schema components that have back-references to ref objects.

    Define this for schema components that have back-references to ref objects. So group def to group ref, globalelementdecl to element ref, type to element, base type to derived type.

    Not for format annotations however. We don't backpoint those to other format annotations that ref them.

    Attributes
    protected
    Definition Classes
    NestingLexicalMixinNestingMixin
  36. final lazy val enclosingElement: Option[ElementBase]

    Permalink

    All schema components except the root have an enclosing element.

    All schema components except the root have an enclosing element.

    Definition Classes
    SchemaComponent
  37. final lazy val enclosingTerm: Option[Term]

    Permalink
    Definition Classes
    SchemaComponent
  38. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  40. def error(th: Diagnostic): Unit

    Permalink
    Definition Classes
    OOLAGHost
  41. final def errors: Seq[Diagnostic]

    Permalink
    Definition Classes
    OOLAGHost
  42. final lazy val external: Boolean

    Permalink
  43. final lazy val fileAttribute: Option[String]

    Permalink
    Definition Classes
    SchemaFileLocatableImpl → SchemaFileLocatable
  44. lazy val fileDescription: String

    Permalink
    Definition Classes
    SchemaFileLocatable → HasSchemaFileLocation → LocationInSchemaFile
  45. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  46. final def findProperty(pname: String): Found

    Permalink
    Definition Classes
    FindPropertyMixin
  47. def findPropertyOption(pname: String): PropertyLookupResult

    Permalink
    Definition Classes
    DFDLAnnotation → FindPropertyMixin
  48. def getAttributeOption(ns: NS, name: String): Option[String]

    Permalink
    Definition Classes
    GetAttributesMixin
  49. def getAttributeOption(name: String): Option[String]

    Permalink
    Definition Classes
    GetAttributesMixin
  50. def getAttributeRequired(name: String): String

    Permalink
    Definition Classes
    GetAttributesMixin
  51. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  52. def getDiagnostics: Seq[Diagnostic]

    Permalink
    Definition Classes
    OOLAGHost → WithDiagnostics
  53. def getLogWriter(): LogWriter

    Permalink
    Definition Classes
    Logging
  54. final def getLoggingLevel(): Type

    Permalink
    Definition Classes
    Logging
  55. final def getProperty(pname: String): String

    Permalink
    Definition Classes
    FindPropertyMixin
  56. final def getPropertyOption(pname: String): Option[String]

    Permalink
    Definition Classes
    FindPropertyMixin
  57. final lazy val globalQName: GlobalQName

    Permalink
    Definition Classes
    GlobalComponent
  58. final lazy val gram: EmptyGram.type

    Permalink
  59. final def hasOOLAGRootSetup: Boolean

    Permalink
    Definition Classes
    OOLAGHost
  60. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  61. def isError: Boolean

    Permalink
    Definition Classes
    OOLAGHost → WithDiagnostics
  62. def isHidden: Boolean

    Permalink

    Whether the component is hidden.

    Whether the component is hidden.

    Override this in the components that can hide - SequenceGroupRef and ChoiceGroupRef

    Definition Classes
    SchemaComponent
  63. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  64. lazy val lineAttribute: Option[String]

    Permalink

    Annotations can contain expressions, so we need to be able to compile them.

    Annotations can contain expressions, so we need to be able to compile them.

    We need our own instance so that the expression compiler has this schema component as its context.

    Definition Classes
    SchemaFileLocatableImpl → SchemaFileLocatable
  65. lazy val lineDescription: String

    Permalink
    Definition Classes
    SchemaFileLocatable → HasSchemaFileLocation → LocationInSchemaFile
  66. lazy val lineNumber: Option[String]

    Permalink
    Definition Classes
    SchemaFileLocatable
  67. lazy val locationDescription: String

    Permalink
    Definition Classes
    SchemaFileLocatable → HasSchemaFileLocation → LocationInSchemaFile
  68. final macro def log(lvl: Type, msg: String, args: Any*): Unit

    Permalink
    Definition Classes
    Logging
  69. lazy val logID: String

    Permalink
    Definition Classes
    Logging → Identity
  70. var logLevel: Maybe[Type]

    Permalink
    Definition Classes
    Logging
  71. var logWriter: Maybe[LogWriter]

    Permalink
    Definition Classes
    Logging
  72. lazy val maybeDefaultValueExpr: Maybe[CompiledExpression[AnyRef]]

    Permalink
  73. def nArgs: Args

    Permalink
    Attributes
    protected
    Definition Classes
    OOLAGHost
  74. lazy val name: String

    Permalink
    Definition Classes
    NamedMixin
  75. def namedQName: NamedQName

    Permalink
    Definition Classes
    GlobalComponentNamedMixin
  76. lazy val namespace: NS

    Permalink
    Definition Classes
    PrefixAndNamespaceMixin
  77. final lazy val namespaces: NamespaceBinding

    Permalink

    Namespace scope for resolving QNames.

    Namespace scope for resolving QNames.

    We insist that the prefix "xsi" is properly defined for use in xsi:nil attributes, which is how we represent nilled elements when we convert to XML.

    Definition Classes
    CommonContextMixin
  78. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  79. final def newDFDLAnnotationXML(label: String): Elem

    Permalink

    Used as factory for the XML Node with the right namespace and prefix etc.

    Used as factory for the XML Node with the right namespace and prefix etc.

    Given "element" it creates <dfdl:element /> with the namespace definitions based on this schema component's corresponding XSD construct.

    Makes sure to inherit the scope so we have all the namespace bindings.

    Attributes
    protected
    Definition Classes
    SchemaComponent
  80. final def newVariableInstance: Variable

    Permalink
  81. final def nonTermRuntimeData: NonTermRuntimeData

    Permalink
    Definition Classes
    SchemaComponent
  82. final def notYetImplemented(msg: String, args: Any*): Nothing

    Permalink
    Definition Classes
    ThrowsSDE
  83. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  85. final lazy val oolagContext: OOLAGHost

    Permalink
    Definition Classes
    OOLAGHost
  86. final def oolagContextViaArgs: Some[SchemaComponent]

    Permalink
    Definition Classes
    SchemaComponent → OOLAGHost
  87. def oolagError(th: Diagnostic): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    OOLAGHost
  88. final def oolagParent: OOLAGHost

    Permalink
    Attributes
    protected
    Definition Classes
    OOLAGHost
  89. def oolagWarn(th: Diagnostic): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    OOLAGHost
  90. final val orElseURL: String

    Permalink
    Attributes
    protected
    Definition Classes
    SchemaComponentIncludesAndImportsMixin
  91. final def parent: AnnotatedSchemaComponent

    Permalink

    The lexically enclosing schema component

    The lexically enclosing schema component

    Definition Classes
    DFDLAnnotationSchemaComponentSchemaFileLocatableImplCommonContextMixinNestingMixin
  92. lazy val path: String

    Permalink

    path is used in diagnostic messages and code debug messages; hence, it is very important that it be very dependable.

    path is used in diagnostic messages and code debug messages; hence, it is very important that it be very dependable.

    Definition Classes
    SchemaComponent → OOLAGHost
  93. final lazy val prefix: String

    Permalink
    Definition Classes
    PrefixAndNamespaceMixin
  94. final lazy val primType: PrimType

    Permalink
  95. def qNameForProperty(local: String, ns: NS): GlobalQName

    Permalink
    Definition Classes
    ResolvesQNames
  96. def removePrefix(prefixedValue: String): String

    Permalink
    Definition Classes
    ResolvesQNames
  97. final def requireProperty(prop: PropertyLookupResult): Found

    Permalink
    Definition Classes
    FindPropertyMixin
  98. final def requiredEvaluations(lv: OOLAGValueBase): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    OOLAGHost
  99. final def requiredEvaluations(arg: ⇒ Any): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    OOLAGHost
  100. def resolveQName(qnString: String): RefQName

    Permalink
    Definition Classes
    ResolvesQNames
  101. final lazy val rootElementDecl: Option[GlobalElementDecl]

    Permalink
    Definition Classes
    SchemaComponent
  102. final lazy val rootElementRef: Option[AbstractElementRef]

    Permalink
    Definition Classes
    SchemaComponent
  103. final lazy val runtimeData: VariableRuntimeData

    Permalink

    ALl non-terms get runtimeData from this definition.

    ALl non-terms get runtimeData from this definition. All Terms which are elements and model-groups) override this.

    The Term class has a generic termRuntimeData => TermRuntimeData function (useful since all Terms share things like having charset encoding) The Element classes all inherit an elementRuntimeData => ElementRuntimeData and the model groups all have modelGroupRuntimeData => ModelGroupRuntimeData.

    There is also VariableRuntimeData and SchemaSetRuntimeData.

    Definition Classes
    DFDLDefineVariableSchemaComponent
  104. final lazy val scPath: Seq[SchemaComponent]

    Permalink

    Includes instances.

    Includes instances. Ie., a global element will appear inside an element ref. a global group inside a group ref, a global type inside an element or for derived simple types inside another simple type, etc.

    Used in diagnostic messages and code debug messages

    Definition Classes
    SchemaComponent
  105. lazy val schema: Schema

    Permalink
    Definition Classes
    CommonContextMixin
  106. lazy val schemaComponent: LookupLocation

    Permalink
    Definition Classes
    SchemaComponent
  107. final def schemaDefinitionError(str: String, args: Any*): Nothing

    Permalink
    Definition Classes
    ThrowsSDE
  108. def schemaDefinitionErrorButContinue(str: String, args: Any*): Unit

    Permalink
    Definition Classes
    SavesErrorsAndWarnings
  109. def schemaDefinitionErrorDueToPropertyValue(propertyName: String, propertyValue: String, propertyLocation: LookupLocation, otherPropertyLocation: LookupLocation, str: String, args: Any*): Nothing

    Permalink
    Definition Classes
    SavesErrorsAndWarnings
  110. final macro def schemaDefinitionUnless(testThatWillThrowIfFalse: Boolean, str: String, args: Any*): Unit

    Permalink
    Definition Classes
    ThrowsSDE
  111. macro def schemaDefinitionWarningUnless(warnID: WarnID, testThatWillWarnIfFalse: Boolean, str: String, args: Any*): Unit

    Permalink
    Definition Classes
    SavesErrorsAndWarnings
  112. macro def schemaDefinitionWarningWhen(warnID: WarnID, testThatWillWarnIfTrue: Boolean, str: String, args: Any*): Unit

    Permalink
    Definition Classes
    SavesErrorsAndWarnings
  113. final macro def schemaDefinitionWhen(testThatWillThrowIfTrue: Boolean, str: String, args: Any*): Unit

    Permalink
    Definition Classes
    ThrowsSDE
  114. def schemaDocument: SchemaDocument

    Permalink
    Definition Classes
    CommonContextMixin
  115. lazy val schemaFile: Option[DFDLSchemaFile]

    Permalink
    Definition Classes
    CommonContextMixin
  116. lazy val schemaFileLocation: SchemaFileLocation

    Permalink
    Definition Classes
    SchemaFileLocatable → HasSchemaFileLocation → ThrowsSDE
  117. lazy val schemaSet: SchemaSet

    Permalink
    Definition Classes
    CommonContextMixin
  118. def setLogWriter(lw: LogWriter): Unit

    Permalink
    Definition Classes
    Logging
  119. def setLoggingLevel(level: Type): Unit

    Permalink
    Definition Classes
    Logging
  120. final def setOOLAGContext(oolagContextArg: OOLAGHost): Unit

    Permalink
    Definition Classes
    OOLAGHost
  121. final lazy val slashPath: String

    Permalink

    Elements only e.g., /foo/ex:bar

    Elements only e.g., /foo/ex:bar

    Definition Classes
    SchemaComponent
  122. def subset(testThatWillThrowIfFalse: Boolean, msg: String, args: Any*): Unit

    Permalink
    Definition Classes
    ImplementsThrowsOrSavesSDE
  123. def subsetError(msg: String, args: Any*): Nothing

    Permalink
    Definition Classes
    ImplementsThrowsOrSavesSDE
  124. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  125. def targetNamespace: NS

    Permalink

    This is the root, or basic target namespace.

    This is the root, or basic target namespace. Every schema component gets its target namespace from its xmlSchemaDocument.

    Definition Classes
    CommonContextMixin
  126. final lazy val targetNamespacePrefix: String

    Permalink
    Definition Classes
    CommonContextMixin
  127. def toString(): String

    Permalink
    Definition Classes
    DFDLAnnotationSchemaComponent → AnyRef → Any
  128. final def toss(th: Throwable): Nothing

    Permalink
    Definition Classes
    ThrowsSDE
  129. def tunable: DaffodilTunables

    Permalink
    Definition Classes
    SchemaComponent → ResolvesQNames → ImplementsThrowsOrSavesSDE
  130. final lazy val typeQName: RefQName

    Permalink
  131. def uriString: String

    Permalink

    Used in diagnostic messages; hence, valueOrElse to avoid problems when this can't get a value due to an error.

    Used in diagnostic messages; hence, valueOrElse to avoid problems when this can't get a value due to an error.

    Definition Classes
    SchemaComponentIncludesAndImportsMixinCommonContextMixin
  132. lazy val uriStringFromAttribute: Option[String]

    Permalink
    Definition Classes
    SchemaFileLocatable
  133. def variableMap: VariableMap

    Permalink
    Definition Classes
    SchemaComponent
  134. final lazy val variableRuntimeData: VariableRuntimeData

    Permalink
  135. final def verifyPropValue(key: String, value: String): Boolean

    Permalink
    Definition Classes
    FindPropertyMixin
  136. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  139. def warn(th: Diagnostic): Unit

    Permalink
    Definition Classes
    OOLAGHost
  140. final def warnings: Seq[Diagnostic]

    Permalink
    Definition Classes
    OOLAGHost
  141. macro def withLoggingLevel[S](newLevel: Type)(body: ⇒ S): Unit

    Permalink
    Definition Classes
    Logging
  142. final val xml: Node

    Permalink
    Definition Classes
    DFDLAnnotationSchemaComponentSchemaFileLocatableImplCommonContextMixin → GetAttributesMixin
  143. lazy val xmlSchemaDocument: XMLSchemaDocument

    Permalink
    Definition Classes
    CommonContextMixin

Inherited from DFDLDefiningAnnotation

Inherited from GlobalComponent

Inherited from PrefixAndNamespaceMixin

Inherited from NamedMixin

Inherited from DFDLAnnotation

Inherited from FindPropertyMixin

Inherited from NestingLexicalMixin

Inherited from SchemaComponent

Inherited from PropTypes

Inherited from SchemaFileLocatableImpl

Inherited from SchemaFileLocatable

Inherited from HasSchemaFileLocation

Inherited from LookupLocation

Inherited from LocationInSchemaFile

Inherited from ResolvesQNames

Inherited from CommonContextMixin

Inherited from NestingMixin

Inherited from GetAttributesMixin

Inherited from ImplementsThrowsOrSavesSDE

Inherited from SavesErrorsAndWarnings

Inherited from ImplementsThrowsSDE

Inherited from ThrowsSDE

Inherited from OOLAGHost

Inherited from NamedMixinBase

Inherited from WithDiagnostics

Inherited from Logging

Inherited from Identity

Inherited from AnyRef

Inherited from Any

Ungrouped