Class

org.apache.daffodil.dsom

DFDLNonDefaultFormatAnnotation

Related Doc: package dsom

Permalink

abstract class DFDLNonDefaultFormatAnnotation extends DFDLFormatAnnotation

Linear Supertypes
DFDLFormatAnnotation, LeafPropProvider, DFDLAnnotation, 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. DFDLNonDefaultFormatAnnotation
  2. DFDLFormatAnnotation
  3. LeafPropProvider
  4. DFDLAnnotation
  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 DFDLNonDefaultFormatAnnotation(node: Node, sc: 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

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 checkErrors: Unit

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

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

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

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

    Permalink
    Definition Classes
    SchemaFileLocatable
  20. final val context: AnnotatedSchemaComponent

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

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

    Permalink
    Definition Classes
    GetAttributesMixin
  23. def dfdlAttributes(n: Node): MetaData

    Permalink
    Definition Classes
    GetAttributesMixin
  24. lazy val diagnosticDebugName: String

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

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

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

    Permalink
    Definition Classes
    SchemaComponent
  28. val emptyPropMap: PropMap

    Permalink
    Definition Classes
    PropTypes
  29. 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
  30. 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
  31. 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
  32. final lazy val enclosingTerm: Option[Term]

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  40. lazy val formatChain: ChainPropProvider

    Permalink
    Definition Classes
    DFDLFormatAnnotation
  41. def getAttributeOption(ns: NS, name: String): Option[String]

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

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

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

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

    Permalink
    Definition Classes
    OOLAGHost → WithDiagnostics
  46. def getFormatRefs(seen: NamedFormatMap): NamedFormatMap

    Permalink

    build up map of what we have 'seen' as we go so we can detect cycles

    build up map of what we have 'seen' as we go so we can detect cycles

    Attributes
    protected
    Definition Classes
    DFDLFormatAnnotation
  47. def getLogWriter(): LogWriter

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

    Permalink
    Definition Classes
    Logging
  49. def getPropertyForUnitTest(propName: String): String

    Permalink

    For unit testing convenience, or for use when debugging.

    For unit testing convenience, or for use when debugging.

    Definition Classes
    DFDLFormatAnnotation
  50. final def hasOOLAGRootSetup: Boolean

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

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

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

    Permalink
    Definition Classes
    Any
  55. final lazy val justThisOneProperties: PropMap

    Permalink

    Just this one, as in the short, long, and element form properties, on just this annotated schema component, not following any ref chains.

    Just this one, as in the short, long, and element form properties, on just this annotated schema component, not following any ref chains. Just the properties right here.

    Needed for certain warnings, and also is the primitive from which the ChainPropProvider is built up. That one DOES follow ref chains.

    Definition Classes
    DFDLFormatAnnotationLeafPropProvider
  56. final def leafFindProperty(pname: String): PropertyLookupResult

    Permalink
    Definition Classes
    LeafPropProvider
  57. 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
  58. lazy val lineDescription: String

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

    Permalink
    Definition Classes
    SchemaFileLocatable
  60. lazy val locationDescription: String

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

    Permalink
    Definition Classes
    Logging
  62. lazy val logID: String

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

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

    Permalink
    Definition Classes
    Logging
  65. def nArgs: Args

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink

    The lexically enclosing schema component

    The lexically enclosing schema component

    Definition Classes
    DFDLAnnotationSchemaComponentSchemaFileLocatableImplCommonContextMixinNestingMixin
  80. 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
  81. final lazy val properties: PropMap

    Permalink

    for debug/test only

    for debug/test only

    Definition Classes
    LeafPropProvider
  82. def qNameForProperty(local: String, ns: NS): GlobalQName

    Permalink
    Definition Classes
    ResolvesQNames
  83. final lazy val ref: Option[String]

    Permalink
    Definition Classes
    DFDLFormatAnnotation
  84. lazy val referencedFormat: Option[DFDLFormat]

    Permalink
    Definition Classes
    DFDLFormatAnnotation
  85. def removePrefix(prefixedValue: String): String

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

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

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

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

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

    Permalink
    Definition Classes
    SchemaComponent
  91. 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
  92. 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
  93. lazy val schema: Schema

    Permalink
    Definition Classes
    CommonContextMixin
  94. lazy val schemaComponent: LookupLocation

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    ThrowsSDE
  102. def schemaDocument: SchemaDocument

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

    Permalink
    Definition Classes
    CommonContextMixin
  104. lazy val schemaFileLocation: SchemaFileLocation

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

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

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

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

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

    Permalink

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    ThrowsSDE
  117. def tunable: DaffodilTunables

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

    Permalink
    Definition Classes
    SchemaFileLocatable
  120. def variableMap: VariableMap

    Permalink
    Definition Classes
    SchemaComponent
  121. def verifyPropValue(propName: String, expectedValue: String): Boolean

    Permalink

    For unit testing convenience, or for use when debugging.

    For unit testing convenience, or for use when debugging.

    Definition Classes
    DFDLFormatAnnotation
  122. final def wait(): Unit

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

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

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

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

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

    Permalink
    Definition Classes
    Logging
  128. final val xml: Node

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

    Permalink
    Definition Classes
    CommonContextMixin

Inherited from DFDLFormatAnnotation

Inherited from LeafPropProvider

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 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