Class

org.apache.daffodil.dsom

IIBase

Related Doc: package dsom

Permalink

abstract class IIBase extends SchemaComponent with NestingLexicalMixin

Include/Import = "II" for short

Linear Supertypes
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. IIBase
  2. NestingLexicalMixin
  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 IIBase(xml: Node, xsdArg: XMLSchemaDocument, seenBefore: IIMap)

    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 mapPair: (NS, DaffodilSchemaSource)

    Permalink
    Attributes
    protected
  2. abstract def resolvedLocation: DaffodilSchemaSource

    Permalink

    Holds the location of the schema, whether that is from the XML Catalog (import), or classpath (import or include).

    Holds the location of the schema, whether that is from the XML Catalog (import), or classpath (import or include).

    Attributes
    protected

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. 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. def dfdlAttributes(n: Node): MetaData

    Permalink
    Definition Classes
    GetAttributesMixin
  23. lazy val diagnosticDebugName: String

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

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

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

    Permalink
    Definition Classes
    SchemaComponent
  27. val emptyPropMap: PropMap

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Logging
  46. final def hasOOLAGRootSetup: Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  48. final def iiSchemaFile: DFDLSchemaFile

    Permalink

    Unconditionally, get the schema file object.

  49. final def iiSchemaFileMaybe: Option[DFDLSchemaFile]

    Permalink

    Get the schema file if it isn't one we have seen before.

    Get the schema file if it isn't one we have seen before.

    If it new to us, then get it. This can cause a failure if the file doesn't exist but we need it to determine the namespace. That is, the Option here does NOT return None for file-not-found. It's only about whether we've already got this file in the (ns, url) map we're maintaining.

    This can succeed even if the file will not be found later when someone asks for the schema document, or if at that point its namespace is not acceptable given the import statement.

  50. def isError: Boolean

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

    Permalink
    Definition Classes
    Any
  53. final def isValidURI(uri: String): Boolean

    Permalink
    Attributes
    protected
  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. final def mapTuple: ((NS, DaffodilSchemaSource), IIBase)

    Permalink
    Attributes
    protected
  63. def nArgs: Args

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

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

    Permalink
    Definition Classes
    SchemaComponent
  68. final def notSeenThisBefore: Boolean

    Permalink
    Attributes
    protected
  69. final def notYetImplemented(msg: String, args: Any*): Nothing

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    SchemaComponentIncludesAndImportsMixin
  78. final def parent: XMLSchemaDocument

    Permalink

    The lexically enclosing schema component

    The lexically enclosing schema component

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

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

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

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

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

    Permalink
    Definition Classes
    ResolvesQNames
  85. final lazy val resolvedSchemaLocation: Option[DaffodilSchemaSource]

    Permalink

    Both include and import have schemaLocation.

    Both include and import have schemaLocation. For import it is optional. If supplied we resolve it via the classpath, relative to the location of the including/importing file, etc.

    Attributes
    protected
  86. final lazy val rootElementDecl: Option[GlobalElementDecl]

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

    Permalink
    Definition Classes
    SchemaComponent
  88. 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
  89. 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
  90. lazy val schema: Schema

    Permalink
    Definition Classes
    CommonContextMixin
  91. lazy val schemaComponent: LookupLocation

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    ThrowsSDE
  99. def schemaDocument: SchemaDocument

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

    Permalink
    Definition Classes
    CommonContextMixin
  101. lazy val schemaFileLocation: SchemaFileLocation

    Permalink
    Definition Classes
    SchemaFileLocatable → HasSchemaFileLocation → ThrowsSDE
  102. final lazy val schemaLocationProperty: Option[String]

    Permalink
  103. lazy val schemaSet: SchemaSet

    Permalink
    Definition Classes
    CommonContextMixin
  104. final def seenAfter: IIMap

    Permalink
  105. val seenBefore: IIMap

    Permalink
  106. final def seenBeforeThisFile: IIMap

    Permalink

    (ns, file) that we've seen before.

    (ns, file) that we've seen before.

    Includes this file we're currently on (if we haven't seen it) so that if our own includes/imports cycle back to us we will detect it.

    Attributes
    protected
  107. def setLogWriter(lw: LogWriter): Unit

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

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

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

    Permalink

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    ThrowsSDE
  118. def tunable: DaffodilTunables

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

    Permalink
    Definition Classes
    SchemaFileLocatable
  121. def variableMap: VariableMap

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

    Permalink
    Attributes
    protected
  128. macro def withLoggingLevel[S](newLevel: Type)(body: ⇒ S): Unit

    Permalink
    Definition Classes
    Logging
  129. final val xml: Node

    Permalink
    Definition Classes
    IIBaseSchemaComponentSchemaFileLocatableImplCommonContextMixin → GetAttributesMixin
  130. lazy val xmlSchemaDocument: XMLSchemaDocument

    Permalink
    Definition Classes
    CommonContextMixin

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