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, ResolvesQNames, SchemaComponentIncludesAndImportsMixin, CommonContextMixin, NestingMixin, GetAttributesMixin, ImplementsThrowsOrSavesSDE, SavesErrorsAndWarnings, ImplementsThrowsSDE, ThrowsSDE, 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. ResolvesQNames
  11. SchemaComponentIncludesAndImportsMixin
  12. CommonContextMixin
  13. NestingMixin
  14. GetAttributesMixin
  15. ImplementsThrowsOrSavesSDE
  16. SavesErrorsAndWarnings
  17. ImplementsThrowsSDE
  18. ThrowsSDE
  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

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. def clone(): AnyRef

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

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

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

    Permalink
    Definition Classes
    SchemaFileLocatable
  19. val context: SchemaComponent

    Permalink
    Definition Classes
    SchemaComponent
  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. lazy val diagnosticDebugName: String

    Permalink
    Definition Classes
    NamedMixinBase
  27. def diagnostics: Seq[Diagnostic]

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

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

    Permalink
    Definition Classes
    SchemaComponent
  30. val emptyPropMap: PropMap

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

    Permalink
    Definition Classes
    SchemaComponent
  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 getDefaultFormat: Seq[DFDLFormat]

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

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

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

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

    Permalink
  51. def getDiagnostics: Seq[Diagnostic]

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

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

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

    Permalink
  55. def getGlobalSimpleTypeDef(name: String): Option[GlobalSimpleTypeDefFactory]

    Permalink
  56. def getLogWriter(): LogWriter

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

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

    Permalink
  59. lazy val globalElementDecls: Seq[GlobalElementDeclFactory]

    Permalink
  60. lazy val globalGroupDefs: Seq[GlobalGroupDefFactory]

    Permalink
  61. lazy val globalSimpleTypeDefs: Seq[GlobalSimpleTypeDefFactory]

    Permalink
  62. final def hasOOLAGRootSetup: Boolean

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

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

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

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

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

    Permalink
    Definition Classes
    SchemaFileLocatable
  70. lazy val locationDescription: String

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

    Permalink
    Definition Classes
    Logging
  72. lazy val logID: String

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

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

    Permalink
    Definition Classes
    Logging
  75. def nArgs: Args

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    SchemaComponentIncludesAndImportsMixin
  90. final val parent: SchemaComponent

    Permalink

    The lexically enclosing schema component

    The lexically enclosing schema component

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    CommonContextMixin
  102. lazy val schemaComponent: LookupLocation

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    ThrowsSDE
  110. lazy val schemaDocument: SchemaDocument

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

    Permalink
  112. lazy val schemaFile: Option[DFDLSchemaFile]

    Permalink
    Definition Classes
    CommonContextMixin
  113. lazy val schemaFileLocation: SchemaFileLocation

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

    Permalink
    Definition Classes
    SchemaCommonContextMixin
  115. def setLogWriter(lw: LogWriter): Unit

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

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

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

    Permalink

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    ThrowsSDE
  126. def tunable: DaffodilTunables

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

    Permalink
    Definition Classes
    SchemaFileLocatable
  129. def variableMap: VariableMap

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

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

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

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

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

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

    Permalink
    Definition Classes
    Logging
  136. final val xml: Node

    Permalink
    Definition Classes
    SchemaComponentImplSchemaComponentSchemaFileLocatableImplCommonContextMixin → GetAttributesMixin
  137. 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 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