Class

org.apache.daffodil.dsom

VariableReference

Related Doc: package dsom

Permalink

abstract class VariableReference extends DFDLStatement

Linear Supertypes
DFDLStatement, 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
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. VariableReference
  2. DFDLStatement
  3. DFDLAnnotation
  4. FindPropertyMixin
  5. NestingLexicalMixin
  6. SchemaComponent
  7. PropTypes
  8. SchemaFileLocatableImpl
  9. SchemaFileLocatable
  10. HasSchemaFileLocation
  11. LookupLocation
  12. LocationInSchemaFile
  13. ResolvesQNames
  14. SchemaComponentIncludesAndImportsMixin
  15. CommonContextMixin
  16. NestingMixin
  17. GetAttributesMixin
  18. ImplementsThrowsOrSavesSDE
  19. SavesErrorsAndWarnings
  20. ImplementsThrowsSDE
  21. ThrowsSDE
  22. OOLAGHost
  23. NamedMixinBase
  24. WithDiagnostics
  25. Logging
  26. Identity
  27. AnyRef
  28. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new VariableReference(node: Node, decl: AnnotatedSchemaComponent)

    Permalink

Type Members

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

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

    Permalink
    Definition Classes
    PropTypes

Abstract Value Members

  1. abstract def gram: Gram

    Permalink
    Definition Classes
    DFDLStatement

Concrete 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 def asInstanceOf[T0]: T0

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    SchemaFileLocatable
  23. final val context: AnnotatedSchemaComponent

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

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

    Permalink
    Definition Classes
    GetAttributesMixin
  26. final lazy val defv: DFDLDefineVariable

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

    Permalink
    Definition Classes
    GetAttributesMixin
  28. lazy val diagnosticDebugName: String

    Permalink
    Definition Classes
    DFDLAnnotation → SchemaFileLocatable → NamedMixinBase
  29. def diagnostics: Seq[Diagnostic]

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

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

    Permalink
    Definition Classes
    SchemaComponent
  32. val emptyPropMap: PropMap

    Permalink
    Definition Classes
    PropTypes
  33. 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
  34. 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
  35. 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
  36. final lazy val enclosingTerm: Option[Term]

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

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

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

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

    Permalink
    Definition Classes
    OOLAGHost
  41. final lazy val fileAttribute: Option[String]

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    FindPropertyMixin
  55. final def hasOOLAGRootSetup: Boolean

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

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

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

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

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

    Permalink
    Definition Classes
    SchemaFileLocatable
  63. lazy val locationDescription: String

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

    Permalink
    Definition Classes
    Logging
  65. lazy val logID: String

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

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

    Permalink
    Definition Classes
    Logging
  68. def nArgs: Args

    Permalink
    Attributes
    protected
    Definition Classes
    OOLAGHost
  69. 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
  70. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  71. 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
  72. final def nonTermRuntimeData: NonTermRuntimeData

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

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

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

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

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

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

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

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

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

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

    Permalink

    The lexically enclosing schema component

    The lexically enclosing schema component

    Definition Classes
    DFDLAnnotationSchemaComponentSchemaFileLocatableImplCommonContextMixinNestingMixin
  83. 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
  84. def qNameForProperty(local: String, ns: NS): GlobalQName

    Permalink
    Definition Classes
    ResolvesQNames
  85. final lazy val ref: String

    Permalink
  86. def removePrefix(prefixedValue: String): String

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

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

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

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

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

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

    Permalink
    Definition Classes
    SchemaComponent
  93. lazy val runtimeData: RuntimeData

    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
    SchemaComponent
  94. 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
  95. lazy val schema: Schema

    Permalink
    Definition Classes
    CommonContextMixin
  96. lazy val schemaComponent: LookupLocation

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    ThrowsSDE
  104. def schemaDocument: SchemaDocument

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

    Permalink
    Definition Classes
    CommonContextMixin
  106. lazy val schemaFileLocation: SchemaFileLocation

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

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

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

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

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

    Permalink

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    ThrowsSDE
  119. def tunable: DaffodilTunables

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

    Permalink
    Definition Classes
    SchemaFileLocatable
  122. final lazy val varQName: RefQName

    Permalink
  123. def variableMap: VariableMap

    Permalink
    Definition Classes
    SchemaComponent
  124. final def variableRuntimeData: VariableRuntimeData

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Logging
  132. final val xml: Node

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

    Permalink
    Definition Classes
    CommonContextMixin

Inherited from DFDLStatement

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