Trait

org.apache.daffodil.grammar

TermGrammarMixin

Related Doc: package grammar

Permalink

trait TermGrammarMixin extends AlignedMixin with BitOrderMixin with TermRuntime1Mixin

Self Type
Term
Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TermGrammarMixin
  2. TermRuntime1Mixin
  3. BitOrderMixin
  4. ByteOrderAnalysisMixin
  5. AlignedMixin
  6. GrammarMixin
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def termContentBody: Gram

    Permalink
  2. abstract def termRuntimeData: TermRuntimeData

    Permalink
    Definition Classes
    TermRuntime1Mixin

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. val NYI: Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    GrammarMixin
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. final lazy val contentLengthParserReferencedElementInfos: Set[DPathElementCompileInfo]

    Permalink

    Set of elements referenced from an expression in the scope of this term.

    Set of elements referenced from an expression in the scope of this term.

    Specific to certain function call contexts e.g., only elements referenced by dfdl:valueLength or dfdl:contentLength.

    Separated by parser/unparser since parsers have to derive from dfdl:inputValueCalc, and must include discriminators and assert test expressions. Unparsers must derive from dfdl:outputValueCalc and exclude discriminators and asserts. Both must include setVariable/newVariableInstance, and property expressions are nearly the same. There are some unparser-specfic properties that take runtime-valued expressions - dfdl:outputNewLine is one example.

    Definition Classes
    TermRuntime1Mixin
  8. final lazy val contentLengthUnparserReferencedElementInfos: Set[DPathElementCompileInfo]

    Permalink

    Any element referenced from an expression in the scope of this term is in this set.

    Any element referenced from an expression in the scope of this term is in this set.

    Definition Classes
    TermRuntime1Mixin
  9. lazy val contentStartAlignment: AlignmentMultipleOf

    Permalink
    Attributes
    protected
    Definition Classes
    AlignedMixin
  10. final lazy val couldHaveSuspensions: Boolean

    Permalink

    For streaming unparser, determines if this Term could have suspensions associated with it.

    For streaming unparser, determines if this Term could have suspensions associated with it.

    Attributes
    protected
    Definition Classes
    TermRuntime1Mixin
  11. final lazy val defaultBitOrder: BitOrder

    Permalink
    Definition Classes
    BitOrderMixin
  12. final lazy val delimMTA: Gram

    Permalink

    Mandatory text alignment for delimiters

    Mandatory text alignment for delimiters

    Attributes
    protected
  13. final lazy val dfdlScopeBegin: Gram

    Permalink
    Attributes
    protected
  14. final lazy val dfdlScopeEnd: Gram

    Permalink
    Attributes
    protected
  15. lazy val elementSpecifiedLengthApprox: LengthApprox

    Permalink
    Attributes
    protected
    Definition Classes
    AlignedMixin
  16. lazy val endingAlignmentApprox: AlignmentMultipleOf

    Permalink
    Attributes
    protected
    Definition Classes
    AlignedMixin
  17. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  19. final lazy val es: SequenceTermBase

    Permalink

    public for unit testing use.

  20. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  21. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  22. final def grammarContext: Term

    Permalink

    For unit testing, we want to create GrammarMixin objects that are not schema components.

    For unit testing, we want to create GrammarMixin objects that are not schema components. So we can't use a self-type here. Instead we define this abstract grammarContext.

    Attributes
    protected
    Definition Classes
    TermGrammarMixinGrammarMixin
  23. lazy val hasEncoding: Boolean

    Permalink
    Attributes
    protected
  24. final lazy val hasNoSkipRegions: Boolean

    Permalink
    Definition Classes
    AlignedMixin
  25. lazy val hasUniformBitOrderThroughout: Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    BitOrderMixin
  26. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  27. final lazy val isDelimiterKnownToBeTextAligned: Boolean

    Permalink
    Definition Classes
    AlignedMixin
  28. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  29. final lazy val isKnownSameBitOrder: Boolean

    Permalink

    Conservatively determines if this term is known to have the same bit order as the previous thing.

    Conservatively determines if this term is known to have the same bit order as the previous thing.

    If uncertain, returns false.

    Attributes
    protected
    Definition Classes
    BitOrderMixin
  30. final lazy val isKnownToBeAligned: Boolean

    Permalink

    true if we can statically determine that the start of this will be properly aligned by where the prior thing left us positioned.

    true if we can statically determine that the start of this will be properly aligned by where the prior thing left us positioned. Hence we are guaranteed to be properly aligned.

    Definition Classes
    AlignedMixin
  31. lazy val isKnownToBeByteAlignedAndByteLength: Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    AlignedMixin
  32. final lazy val isKnownToBeTextAligned: Boolean

    Permalink

    True if alignment for a text feature of this Term (e.g., an initiator) is provably not needed, either because there is no requirement for such alignment, or we can prove that the required alignment is already established.

    True if alignment for a text feature of this Term (e.g., an initiator) is provably not needed, either because there is no requirement for such alignment, or we can prove that the required alignment is already established.

    This goes further TermEncodingMixin.hasTextAlignment because it considers the surrounding context meeting the alignment needs.

    Definition Classes
    AlignedMixin
  33. lazy val leadingSkipInBits: Int

    Permalink
    Definition Classes
    AlignedMixin
  34. lazy val maybeCheckBitOrderAndCharset: Maybe[CheckBitOrderAndCharsetEv]

    Permalink
    Definition Classes
    BitOrderMixin
  35. lazy val maybeCheckByteAndBitOrderEv: Maybe[CheckByteAndBitOrderEv]

    Permalink
    Definition Classes
    BitOrderMixin
  36. final def mt: Gram

    Permalink
    Attributes
    protected
    Definition Classes
    GrammarMixin
  37. final lazy val mtaBase: Gram

    Permalink

    Mandatory text alignment or mta

    Mandatory text alignment or mta

    mta can only apply to things with encodings. No encoding, no MTA.

    In addition, it has to be textual data. Just because there's an encoding in the property environment shouldn't get you an MTA region. It has to be textual.

    Attributes
    protected
  38. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  39. final lazy val needsBitOrderChange: Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    BitOrderMixin
  40. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  42. final lazy val optDefaultBitOrder: Option[BitOrder]

    Permalink
    Attributes
    protected
    Definition Classes
    BitOrderMixin
  43. final lazy val partialNextElementResolver: PartialNextElementResolver

    Permalink

    The PartialNextElementResolver is used to determine what infoset event comes next, and "resolves" which is to say determines the ElementRuntimeData for that infoset event.

    The PartialNextElementResolver is used to determine what infoset event comes next, and "resolves" which is to say determines the ElementRuntimeData for that infoset event. This can be used to construct the initial infoset from a stream of XML events.

    Definition Classes
    TermRuntime1Mixin
  44. lazy val possibleNextLexicalSiblingStreamingUnparserElements: PossibleNextElements

    Permalink
    Definition Classes
    TermRuntime1Mixin
  45. final lazy val possibleSelfPlusNextLexicalSiblingStreamingUnparserElements: PossibleNextElements

    Permalink
    Attributes
    protected
    Definition Classes
    TermRuntime1Mixin
  46. def prod(prodName: String)(gram: ⇒ Gram): Gram

    Permalink

    Use when production has no guard, but you want to name the production anyway (for debug visibility perhaps).

    Use when production has no guard, but you want to name the production anyway (for debug visibility perhaps).

    Definition Classes
    GrammarMixin
  47. def prod(prodName: String, guard: Boolean = true, forWhat: ParserOrUnparser = BothParserAndUnparser)(gram: ⇒ Gram): Gram

    Permalink

    Use when production has a guard predicate

    Use when production has a guard predicate

    Definition Classes
    GrammarMixin
  48. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  49. final lazy val thereIsAByteOrderDefined: Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    ByteOrderAnalysisMixin
  50. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  51. lazy val trailingSkipApprox: LengthApprox

    Permalink
    Attributes
    protected
    Definition Classes
    AlignedMixin
  52. lazy val trailingSkipInBits: Int

    Permalink
    Definition Classes
    AlignedMixin
  53. final lazy val valueLengthParserReferencedElementInfos: Set[DPathElementCompileInfo]

    Permalink

    Any element referenced from an expression in the scope of this term is in this set.

    Any element referenced from an expression in the scope of this term is in this set.

    Definition Classes
    TermRuntime1Mixin
  54. final lazy val valueLengthUnparserReferencedElementInfos: Set[DPathElementCompileInfo]

    Permalink

    Any element referenced from an expression in the scope of this term is in this set.

    Any element referenced from an expression in the scope of this term is in this set.

    Definition Classes
    TermRuntime1Mixin
  55. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from TermRuntime1Mixin

Inherited from BitOrderMixin

Inherited from ByteOrderAnalysisMixin

Inherited from AlignedMixin

Inherited from GrammarMixin

Inherited from AnyRef

Inherited from Any

Ungrouped