Class

org.apache.daffodil.dsom

DFDLDefineVariable

Related Doc: package dsom

Permalink

class DFDLDefineVariable extends DFDLDefiningAnnotation

Linear Supertypes
DFDLDefiningAnnotation, GlobalNonElementComponentMixin, GlobalComponent, PrefixAndNamespaceMixin, NamedMixin, DFDLAnnotation, NestingLexicalMixin, SchemaComponent, PropTypes, SchemaFileLocatableImpl, SchemaFileLocatable, HasSchemaFileLocation, LookupLocation, LocationInSchemaFile, SchemaComponentIncludesAndImportsMixin, CommonContextMixin, NestingMixin, GetAttributesMixin, BasicComponent, ImplementsThrowsOrSavesSDE, SavesErrorsAndWarnings, ImplementsThrowsSDE, ResolvesQNames, ThrowsSDE, HasTunable, 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. NestingLexicalMixin
  9. SchemaComponent
  10. PropTypes
  11. SchemaFileLocatableImpl
  12. SchemaFileLocatable
  13. HasSchemaFileLocation
  14. LookupLocation
  15. LocationInSchemaFile
  16. SchemaComponentIncludesAndImportsMixin
  17. CommonContextMixin
  18. NestingMixin
  19. GetAttributesMixin
  20. BasicComponent
  21. ImplementsThrowsOrSavesSDE
  22. SavesErrorsAndWarnings
  23. ImplementsThrowsSDE
  24. ResolvesQNames
  25. ThrowsSDE
  26. HasTunable
  27. OOLAGHost
  28. NamedMixinBase
  29. WithDiagnostics
  30. Logging
  31. Identity
  32. AnyRef
  33. 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 checkErrors: Unit

    Permalink
    Definition Classes
    OOLAGHost
  17. final def ci: DPathCompileInfo

    Permalink

    Abbreviation.

    Abbreviation. We use this very often.

    Definition Classes
    SchemaComponent
  18. def clone(): AnyRef

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

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

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

    Permalink
    Definition Classes
    SchemaFileLocatable
  22. final var currentOVList: Seq[OOLAGValueBase]

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

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

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

    Permalink
    Definition Classes
    GetAttributesMixin
  26. def dfdlxAttributes(n: Node): MetaData

    Permalink
    Definition Classes
    GetAttributesMixin
  27. lazy val diagnosticDebugName: String

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

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

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

    Permalink
    Definition Classes
    SchemaComponent
  31. val emptyPropMap: PropMap

    Permalink
    Definition Classes
    PropTypes
  32. 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
  33. lazy val 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
  34. final lazy val enclosingComponentDefs: Seq[EnclosingComponentDef]

    Permalink
    Attributes
    protected
    Definition Classes
    NestingLexicalMixinNestingMixin
  35. final lazy val enclosingComponents: Seq[EnclosingComponentDef]

    Permalink
    Definition Classes
    NestingMixin
  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 enclosingElements: Seq[ElementBase]

    Permalink

    Elements that enclose this.

    Elements that enclose this.

    If this is already an element, this still walks outward to find the next tier out.

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

    Permalink
    Definition Classes
    SchemaComponent
  39. final lazy val enclosingTerms: Seq[Term]

    Permalink

    The terms that can enclose this.

    The terms that can enclose this.

    Even if this is already a term, this walks outward to find those enclosing this.

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  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 lazy val globalQName: GlobalQName

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

    Permalink
  57. final def hasOOLAGRootSetup: Boolean

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

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

    Permalink
    Definition Classes
    OOLAGHost → WithDiagnostics
  60. 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
  61. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  62. 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
  63. lazy val lineDescription: String

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

    Permalink
    Definition Classes
    SchemaFileLocatable
  65. lazy val locationDescription: String

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

    Permalink
    Definition Classes
    Logging
  67. lazy val logID: String

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

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

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

    Permalink
  71. def nArgs: Args

    Permalink
    Attributes
    protected
    Definition Classes
    OOLAGHost
  72. def name: String

    Permalink
    Definition Classes
    NamedMixin
  73. def namedQName: NamedQName

    Permalink
    Definition Classes
    GlobalComponentNamedMixin
  74. lazy val namespace: NS

    Permalink
    Definition Classes
    PrefixAndNamespaceMixin
  75. 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
  76. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  77. 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
  78. final def newVariableInstance: Variable

    Permalink
  79. final def nonTermRuntimeData: NonTermRuntimeData

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

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

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

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

    Permalink
    Definition Classes
    OOLAGHost
  84. def oolagContextViaArgs: Option[SchemaComponent]

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    OOLAGHost
  88. final val optLexicalParent: Option[AnnotatedSchemaComponent]

    Permalink

    The lexically enclosing schema component

    The lexically enclosing schema component

    Definition Classes
    DFDLAnnotationSchemaFileLocatableImplCommonContextMixinNestingMixin
  89. final lazy val optOolagContext: Option[OOLAGHost]

    Permalink
    Definition Classes
    OOLAGHost
  90. final val orElseURL: String

    Permalink
    Attributes
    protected
    Definition Classes
    SchemaComponentIncludesAndImportsMixin
  91. 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
  92. final lazy val prefix: String

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

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

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

    Permalink
    Definition Classes
    ResolvesQNames
  96. final def requiredEvaluations(lv: OOLAGValueBase): Unit

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

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

    Permalink
    Definition Classes
    ResolvesQNames
  99. 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
  100. lazy val schema: Schema

    Permalink
    Definition Classes
    CommonContextMixin
  101. lazy val schemaComponent: LookupLocation

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    ThrowsSDE
  109. def schemaDocument: SchemaDocument

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

    Permalink
    Definition Classes
    CommonContextMixin
  111. lazy val schemaFileLocation: SchemaFileLocation

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

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

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

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

    Permalink
    Definition Classes
    OOLAGHost
  116. lazy val shortSchemaComponentDesignator: String

    Permalink
    Definition Classes
    SchemaComponentNestingMixin
  117. final lazy val slashPath: String

    Permalink

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  121. 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
  122. final lazy val targetNamespacePrefix: String

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

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

    Permalink
    Definition Classes
    ThrowsSDE
  125. lazy val tunable: DaffodilTunables

    Permalink
    Definition Classes
    SchemaComponent → ImplementsThrowsOrSavesSDE → HasTunable
  126. final lazy val typeQName: RefQName

    Permalink
  127. final lazy val unqualifiedPathStepPolicy: UnqualifiedPathStepPolicy

    Permalink
    Definition Classes
    SchemaComponent → ResolvesQNames
  128. 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
  129. lazy val uriStringFromAttribute: Option[String]

    Permalink
    Definition Classes
    SchemaFileLocatable
  130. def variableMap: VariableMap

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

    Permalink
  132. final def wait(): Unit

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

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

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

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

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

    Permalink
    Definition Classes
    Logging
  138. final val xml: Node

    Permalink
    Definition Classes
    DFDLAnnotationSchemaComponentSchemaFileLocatableImplCommonContextMixin → GetAttributesMixin
  139. 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 NestingLexicalMixin

Inherited from SchemaComponent

Inherited from PropTypes

Inherited from SchemaFileLocatableImpl

Inherited from SchemaFileLocatable

Inherited from HasSchemaFileLocation

Inherited from LookupLocation

Inherited from LocationInSchemaFile

Inherited from CommonContextMixin

Inherited from NestingMixin

Inherited from GetAttributesMixin

Inherited from BasicComponent

Inherited from ImplementsThrowsOrSavesSDE

Inherited from SavesErrorsAndWarnings

Inherited from ImplementsThrowsSDE

Inherited from ResolvesQNames

Inherited from ThrowsSDE

Inherited from HasTunable

Inherited from OOLAGHost

Inherited from NamedMixinBase

Inherited from WithDiagnostics

Inherited from Logging

Inherited from Identity

Inherited from AnyRef

Inherited from Any

Ungrouped