Class

org.apache.daffodil.dsom

Schema

Related Doc: package dsom

Permalink

final class Schema extends SchemaComponentImpl

A schema is all the schema documents sharing a single target namespace.

That is, one can write several schema documents which all have the same target namespace, and in that case all those schema documents make up the 'schema'.

Linear Supertypes
SchemaComponentImpl, 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. Schema
  2. SchemaComponentImpl
  3. SchemaComponent
  4. PropTypes
  5. SchemaFileLocatableImpl
  6. SchemaFileLocatable
  7. HasSchemaFileLocation
  8. LookupLocation
  9. LocationInSchemaFile
  10. SchemaComponentIncludesAndImportsMixin
  11. CommonContextMixin
  12. NestingMixin
  13. GetAttributesMixin
  14. BasicComponent
  15. ImplementsThrowsOrSavesSDE
  16. SavesErrorsAndWarnings
  17. ImplementsThrowsSDE
  18. ResolvesQNames
  19. ThrowsSDE
  20. HasTunable
  21. OOLAGHost
  22. NamedMixinBase
  23. WithDiagnostics
  24. Logging
  25. Identity
  26. AnyRef
  27. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Schema(namespace: NS, schemaDocs: Seq[SchemaDocument], schemaSetArg: SchemaSet)

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

    Definition Classes
    SchemaComponent
  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. lazy val defineEscapeSchemes: Seq[DFDLDefineEscapeSchemeFactory]

    Permalink
  23. lazy val defineFormats: Seq[DFDLDefineFormat]

    Permalink
  24. lazy val defineVariables: Seq[DFDLDefineVariable]

    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
    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. final def enclosingComponentDef: None.type

    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
    SchemaNestingMixin
  34. final def enclosingComponentDefs: Seq[Nothing]

    Permalink
    Attributes
    protected
    Definition Classes
    SchemaNestingMixin
  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 fileAttribute: Option[String]

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  51. def getDefaultFormat: Seq[DFDLFormat]

    Permalink
  52. def getDefineEscapeScheme(name: String): Option[DFDLDefineEscapeSchemeFactory]

    Permalink
  53. def getDefineFormat(name: String): Option[DFDLDefineFormat]

    Permalink
  54. def getDefineFormats(): Seq[DFDLDefineFormat]

    Permalink
  55. def getDefineVariable(name: String): Option[DFDLDefineVariable]

    Permalink
  56. def getDiagnostics: Seq[Diagnostic]

    Permalink
    Definition Classes
    OOLAGHost → WithDiagnostics
  57. def getGlobalComplexTypeDef(name: String): Option[GlobalComplexTypeDefFactory]

    Permalink
  58. def getGlobalElementDecl(name: String): Option[GlobalElementDeclFactory]

    Permalink

    Given a name, retrieve the appropriate object.

    Given a name, retrieve the appropriate object.

    This just scans each schema document in the schema, checking each one.

  59. def getGlobalGroupDef(name: String): Option[GlobalGroupDefFactory]

    Permalink
  60. def getGlobalSimpleTypeDef(name: String): Option[GlobalSimpleTypeDef]

    Permalink
  61. def getLogWriter(): LogWriter

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

    Permalink
    Definition Classes
    Logging
  63. lazy val globalComplexTypeDefs: Seq[GlobalComplexTypeDefFactory]

    Permalink
  64. lazy val globalElementDecls: Seq[GlobalElementDeclFactory]

    Permalink
  65. lazy val globalGroupDefs: Seq[GlobalGroupDefFactory]

    Permalink
  66. lazy val globalSimpleTypeDefs: Seq[GlobalSimpleTypeDef]

    Permalink
  67. final def hasOOLAGRootSetup: Boolean

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

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

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

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

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

    Permalink
    Definition Classes
    SchemaFileLocatable
  75. lazy val locationDescription: String

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

    Permalink
    Definition Classes
    Logging
  77. lazy val logID: String

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

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

    Permalink
    Definition Classes
    Logging
  80. def nArgs: Args

    Permalink
    Attributes
    protected
    Definition Classes
    OOLAGHost
  81. val namespace: NS

    Permalink
  82. 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
  83. final def ne(arg0: AnyRef): Boolean

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    OOLAGHost
  94. final val optLexicalParent: Option[SchemaComponent]

    Permalink

    The lexically enclosing schema component

    The lexically enclosing schema component

    Definition Classes
    SchemaComponentImplSchemaFileLocatableImplCommonContextMixinNestingMixin
  95. final lazy val optOolagContext: Option[OOLAGHost]

    Permalink
    Definition Classes
    OOLAGHost
  96. final val orElseURL: String

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

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

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

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

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

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

    Permalink
    Definition Classes
    CommonContextMixin
  105. lazy val schemaComponent: LookupLocation

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    ThrowsSDE
  113. lazy val schemaDocument: SchemaDocument

    Permalink
    Definition Classes
    SchemaCommonContextMixin
  114. lazy val schemaDocuments: Seq[SchemaDocument]

    Permalink
  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
    SchemaCommonContextMixin
  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. lazy val shortSchemaComponentDesignator: String

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

    Permalink

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  126. 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
    SchemaCommonContextMixin
  127. final lazy val targetNamespacePrefix: String

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

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

    Permalink
    Definition Classes
    ThrowsSDE
  130. lazy val tunable: DaffodilTunables

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

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

    Permalink
    Definition Classes
    SchemaFileLocatable
  134. def variableMap: VariableMap

    Permalink
    Definition Classes
    SchemaComponent
  135. final def wait(): Unit

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

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

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

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

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

    Permalink
    Definition Classes
    Logging
  141. final val xml: Node

    Permalink
    Definition Classes
    SchemaComponentImplSchemaComponentSchemaFileLocatableImplCommonContextMixin → GetAttributesMixin
  142. lazy val xmlSchemaDocument: XMLSchemaDocument

    Permalink
    Definition Classes
    CommonContextMixin

Inherited from SchemaComponentImpl

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