Trait

org.apache.daffodil.dsom

SchemaComponent

Related Doc: package dsom

Permalink

trait SchemaComponent extends BasicComponent with ImplementsThrowsOrSavesSDE with GetAttributesMixin with SchemaComponentIncludesAndImportsMixin with ResolvesQNames with SchemaFileLocatableImpl with PropTypes

The core root class of the DFDL Schema object model.

Every schema component has a schema document, and a schema, and a namespace.

Linear Supertypes
PropTypes, SchemaFileLocatableImpl, SchemaFileLocatable, HasSchemaFileLocation, LookupLocation, LocationInSchemaFile, SchemaComponentIncludesAndImportsMixin, CommonContextMixin, NestingMixin, GetAttributesMixin, BasicComponent, ImplementsThrowsOrSavesSDE, SavesErrorsAndWarnings, ImplementsThrowsSDE, ResolvesQNames, ThrowsSDE, HasTunable, OOLAGHost, NamedMixinBase, WithDiagnostics, Logging, Identity, AnyRef, Any
Known Subclasses
AbstractElementRef, AnnotatedSchemaComponent, AnnotatedSchemaComponentImpl, Choice, ChoiceBranchImpliedSequence, ChoiceDefMixin, ChoiceGroupRef, ChoiceTermBase, ComplexTypeBase, DFDLAnnotation, DFDLAssert, DFDLAssertionBase, DFDLChoice, DFDLDefineEscapeScheme, DFDLDefineEscapeSchemeFactory, DFDLDefineFormat, DFDLDefineVariable, DFDLDefiningAnnotation, DFDLDiscriminator, DFDLElement, DFDLEnumerationFactory, DFDLEscapeScheme, DFDLFormat, DFDLFormatAnnotation, DFDLGroup, DFDLModelGroup, DFDLNewVariableInstance, DFDLNonDefaultFormatAnnotation, DFDLProperty, DFDLSchemaFile, DFDLSequence, DFDLSetVariable, DFDLSimpleType, DFDLStatement, ElementBase, ElementDeclFactoryDelegatingMixin, ElementDeclFactoryImplMixin, ElementDeclInstanceImplMixin, ElementDeclMixin, ElementDeclNonFactoryDelegatingMixin, ElementLikeMixin, ElementRef, EnumerationDefFactory, GlobalChoiceGroupDef, GlobalComplexTypeDef, GlobalComplexTypeDefFactory, GlobalElementDecl, GlobalElementDeclFactory, GlobalGroupDef, GlobalGroupDefFactory, GlobalSequenceGroupDef, GlobalSimpleTypeDef, GroupDefLike, GroupRefFactory, HasOptRepTypeMixinImpl, HasRepValueAttributes, IIBase, Import, Include, LocalComplexTypeDef, LocalElementDecl, LocalElementDeclBase, LocalSimpleTypeDef, ModelGroup, PrefixLengthQuasiElementDecl, ProcessorFactory, QuasiElementDeclBase, RepTypeQuasiElementDecl, Restriction, Root, Schema, SchemaComponentFactory, SchemaComponentImpl, SchemaDocument, SchemaSet, Sequence, SequenceDefMixin, SequenceGroupRef, SequenceGroupTermBase, SequenceTermBase, SimpleTypeDefBase, Term, Union, VariableReference, XMLSchemaDocument
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SchemaComponent
  2. PropTypes
  3. SchemaFileLocatableImpl
  4. SchemaFileLocatable
  5. HasSchemaFileLocation
  6. LookupLocation
  7. LocationInSchemaFile
  8. SchemaComponentIncludesAndImportsMixin
  9. CommonContextMixin
  10. NestingMixin
  11. GetAttributesMixin
  12. BasicComponent
  13. ImplementsThrowsOrSavesSDE
  14. SavesErrorsAndWarnings
  15. ImplementsThrowsSDE
  16. ResolvesQNames
  17. ThrowsSDE
  18. HasTunable
  19. OOLAGHost
  20. NamedMixinBase
  21. WithDiagnostics
  22. Logging
  23. Identity
  24. AnyRef
  25. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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 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
    NestingMixin
  2. abstract def enclosingComponentDefs: Seq[EnclosingComponentDef]

    Permalink
    Attributes
    protected
    Definition Classes
    NestingMixin
  3. abstract def optLexicalParent: Option[SchemaComponent]

    Permalink
    Definition Classes
    SchemaFileLocatableImpl
  4. abstract def xml: Node

    Permalink
    Definition Classes
    SchemaComponentSchemaFileLocatableImplCommonContextMixin → GetAttributesMixin

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 def areLogging(lvl: Type): Boolean

    Permalink
    Definition Classes
    Logging
  12. final def asInstanceOf[T0]: T0

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

    Permalink
    Definition Classes
    OOLAGHost
  14. final def checkErrors: Unit

    Permalink
    Definition Classes
    OOLAGHost
  15. final def ci: DPathCompileInfo

    Permalink

    Abbreviation.

    Abbreviation. We use this very often.

  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 var currentOVList: Seq[OOLAGValueBase]

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

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

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

    Permalink
    Definition Classes
    GetAttributesMixin
  24. lazy val diagnosticDebugName: String

    Permalink
    Definition Classes
    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
  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. final lazy val enclosingComponents: Seq[EnclosingComponentDef]

    Permalink
    Definition Classes
    NestingMixin
  31. final lazy val enclosingElement: Option[ElementBase]

    Permalink

    All schema components except the root have an enclosing element.

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

  33. final lazy val enclosingTerm: Option[Term]

    Permalink
  34. 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.

  35. final def eq(arg0: AnyRef): Boolean

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

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

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

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

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  42. def getAttributeOption(ns: NS, name: String): Option[String]

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

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

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

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

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

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

    Permalink
    Definition Classes
    Logging
  49. final def hasOOLAGRootSetup: Boolean

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

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

    Permalink
    Definition Classes
    OOLAGHost → WithDiagnostics
  52. 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

  53. final def isInstanceOf[T0]: Boolean

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

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

    Permalink
    Definition Classes
    SchemaFileLocatable
  57. lazy val locationDescription: String

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

    Permalink
    Definition Classes
    Logging
  59. lazy val logID: String

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

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

    Permalink
    Definition Classes
    Logging
  62. def nArgs: Args

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

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

    Permalink
  67. final def notYetImplemented(msg: String, args: Any*): Nothing

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    OOLAGHost
  75. final lazy val optOolagContext: Option[OOLAGHost]

    Permalink
    Definition Classes
    OOLAGHost
  76. final val orElseURL: String

    Permalink
    Attributes
    protected
    Definition Classes
    SchemaComponentIncludesAndImportsMixin
  77. 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
  78. def qNameForProperty(local: String, ns: NS): GlobalQName

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

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

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

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

    Permalink
    Definition Classes
    ResolvesQNames
  83. 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.

  84. lazy val schema: Schema

    Permalink
    Definition Classes
    CommonContextMixin
  85. lazy val schemaComponent: LookupLocation

    Permalink
  86. final def schemaDefinitionError(str: String, args: Any*): Nothing

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

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

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

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

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

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

    Permalink
    Definition Classes
    ThrowsSDE
  93. def schemaDocument: SchemaDocument

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

    Permalink
    Definition Classes
    CommonContextMixin
  95. lazy val schemaFileLocation: SchemaFileLocation

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

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

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

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

    Permalink
    Definition Classes
    OOLAGHost
  100. lazy val shortSchemaComponentDesignator: String

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

    Permalink

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

  102. def subset(testThatWillThrowIfFalse: Boolean, msg: String, args: Any*): Unit

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

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

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

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

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

    Permalink
    Definition Classes
    ThrowsSDE
  109. lazy val tunable: DaffodilTunables

    Permalink
    Definition Classes
    SchemaComponent → ImplementsThrowsOrSavesSDE → HasTunable
  110. final lazy val unqualifiedPathStepPolicy: UnqualifiedPathStepPolicy

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

    Permalink
    Definition Classes
    SchemaFileLocatable
  113. def variableMap: VariableMap

    Permalink
  114. final def wait(): Unit

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

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

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

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

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

    Permalink
    Definition Classes
    Logging
  120. lazy val xmlSchemaDocument: XMLSchemaDocument

    Permalink
    Definition Classes
    CommonContextMixin

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