Trait

org.apache.daffodil.schema.annotation.props.gen

GroupAGMixin

Related Doc: package gen

Permalink

trait GroupAGMixin extends PropertyMixin with GroupCommonAGMixin with SequenceAGMixin with LayeringAGMixin with ExtLayeringAGMixin with ChoiceAGMixin with SeparatorAGMixin

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GroupAGMixin
  2. SeparatorAGMixin
  3. SeparatorPolicyMixin
  4. SeparatorPositionMixin
  5. ChoiceAGMixin
  6. ChoiceLengthKindMixin
  7. ExtLayeringAGMixin
  8. LayeringAGMixin
  9. LayerLengthUnitsMixin
  10. LayerLengthKindMixin
  11. SequenceAGMixin
  12. SequenceKindMixin
  13. GroupCommonAGMixin
  14. PropertyMixin
  15. Logging
  16. Identity
  17. SavesErrorsAndWarnings
  18. ThrowsSDE
  19. FindPropertyMixin
  20. PropTypes
  21. AnyRef
  22. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type PropItem = (String, (String, LookupLocation))

    Permalink

    type of a map entry which maps a property name as key, to a property value, and along side it is a LookupLocation object telling us where we found that property value.

    type of a map entry which maps a property name as key, to a property value, and along side it is a LookupLocation object telling us where we found that property value.

    The property maps/lists in DFDLFormatAnnotation have been enhanced to have this LookupLocation thing along their side to allow issuing better diagnostic messages about conflicting property definitions

    Definition Classes
    PropTypes
  2. type PropMap = Map[String, (String, LookupLocation)]

    Permalink
    Definition Classes
    PropTypes

Abstract Value Members

  1. abstract def SDE(id: String, args: Any*): Nothing

    Permalink
    Definition Classes
    SavesErrorsAndWarnings
  2. abstract def SDEButContinue(str: String, args: Any*): Unit

    Permalink
    Definition Classes
    SavesErrorsAndWarnings
  3. abstract def SDW(warnID: WarnID, str: String, args: Any*): Unit

    Permalink

    Issue a warning.

    Issue a warning. The WarnID enables suppression of warning messages.

    Definition Classes
    SavesErrorsAndWarnings
  4. abstract def lookupProperty(pname: String): PropertyLookupResult

    Permalink

    Implemented in various ways by users of the mixin to find a property.

    Implemented in various ways by users of the mixin to find a property. This should never be directly called to find a property. Instead one should use findPropertyOption and friends, which ensure that caching is consistent.

    Attributes
    protected
    Definition Classes
    FindPropertyMixin
  5. abstract def schemaFileLocation: SchemaFileLocation

    Permalink
    Definition Classes
    ThrowsSDE

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 SDE(th: Throwable): Nothing

    Permalink
    Definition Classes
    ThrowsSDE
  5. def ThrowSDE: PartialFunction[Throwable, Nothing]

    Permalink
    Definition Classes
    ThrowsSDE
  6. final def areLogging(lvl: Type): Boolean

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

    Permalink
    Definition Classes
    Any
  8. def choiceAGInit(): Unit

    Permalink
    Definition Classes
    ChoiceAGMixin
  9. final def choiceBranchKeyKind: ChoiceKeyKindType

    Permalink
    Definition Classes
    ChoiceAGMixin
  10. final def choiceBranchKeyKind_location: LookupLocation

    Permalink
    Definition Classes
    ChoiceAGMixin
  11. final def choiceDispatchKeyKind: ChoiceKeyKindType

    Permalink
    Definition Classes
    ChoiceAGMixin
  12. final def choiceDispatchKeyKind_location: LookupLocation

    Permalink
    Definition Classes
    ChoiceAGMixin
  13. final def choiceLength: Int

    Permalink
    Definition Classes
    ChoiceAGMixin
  14. final def choiceLengthKind: ChoiceLengthKind

    Permalink
    Definition Classes
    ChoiceLengthKindMixin
  15. final def choiceLengthKindInit(): Unit

    Permalink
    Definition Classes
    ChoiceLengthKindMixin
  16. final def choiceLengthKindToString(): String

    Permalink

    This will print the property value if the property has any value in scope.

    This will print the property value if the property has any value in scope. This is mostly for debugging purposes.

    Definition Classes
    ChoiceLengthKindMixin
  17. final def choiceLengthKind_location: LookupLocation

    Permalink
    Definition Classes
    ChoiceLengthKindMixin
  18. final def choiceLength_location: LookupLocation

    Permalink
    Definition Classes
    ChoiceAGMixin
  19. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. def convertToBoolean(pv: String): Boolean

    Permalink

    Convert a property string value to a Boolean

    Convert a property string value to a Boolean

    Note: no error checking is required, as we assume the schema has already been validated, so we only have to deal with the valid formats for Boolean.

    Definition Classes
    PropertyMixin
  21. def convertToDouble(pv: String): Double

    Permalink
    Definition Classes
    PropertyMixin
  22. def convertToFloat(pv: String): Float

    Permalink
    Definition Classes
    PropertyMixin
  23. def convertToInt(pv: String): Int

    Permalink

    Convert a property string value to a Int

    Convert a property string value to a Int

    Note: no error checking is required, as we assume the schema has already been validated, so we only have to deal with the valid formats for Int.

    Definition Classes
    PropertyMixin
  24. def convertToNCName(pv: String): String

    Permalink
    Definition Classes
    PropertyMixin
  25. def convertToQName(pv: String, pl: LookupLocation): RefQName

    Permalink
    Definition Classes
    PropertyMixin
  26. def convertToString(pv: String): String

    Permalink

    There's no conversion to do here, but to eliminate a special case in the code generator we always generate a call to a convertToTYPE function.

    There's no conversion to do here, but to eliminate a special case in the code generator we always generate a call to a convertToTYPE function.

    Definition Classes
    PropertyMixin
  27. def doLogging(lvl: Type, msg: String, args: Seq[Any]): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  28. val emptyPropMap: PropMap

    Permalink
    Definition Classes
    PropTypes
  29. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  31. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  32. final def findProperty(pname: String): Found

    Permalink

    Call this to find/get a property.

    Call this to find/get a property.

    Property values are non-optional in DFDL. If they're not there but a format requires them, then it's always an error.

    Note also that DFDL doesn't have default values for properties. That means that most use of properties is unconditional. Get the property value, and it must be there, or its an error. There are very few exceptions to this rule.

    Definition Classes
    FindPropertyMixin
  33. def findPropertyOption(pname: String): PropertyLookupResult

    Permalink
    Definition Classes
    FindPropertyMixin
  34. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  35. def getLogWriter(): LogWriter

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

    Permalink
    Definition Classes
    Logging
  37. final def getProperty(pname: String): String

    Permalink

    It is ok to use getProperty if the resulting property value cannot ever contain a QName that would have to be resolved.

    It is ok to use getProperty if the resulting property value cannot ever contain a QName that would have to be resolved.

    Definition Classes
    FindPropertyMixin
  38. final def getPropertyOption(pname: String): Option[String]

    Permalink

    Don't use this much.

    Don't use this much. If an SDE needs to be reported, you won't have the source of the property to put into the message. Use findPropertyOption instead. That returns the value and the LookupLocation where it was found for use in diagnostics.

    Also, don't use if the property value could ever contain a QName, because one needs that LookupLocation to resolve QNames properly.

    Note: any expression can contain QNames, so no expression-valued property or one that could be a value or an expression, should ever use this or getProperty.

    See JIRA DFDL-506.

    Definition Classes
    FindPropertyMixin
  39. def groupAGInit(): Unit

    Permalink
  40. def groupCommonAGInit(): Unit

    Permalink
    Definition Classes
    GroupCommonAGMixin
  41. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  42. final def initiatedContent: YesNo

    Permalink
    Definition Classes
    GroupCommonAGMixin
  43. final def initiatedContent_location: LookupLocation

    Permalink
    Definition Classes
    GroupCommonAGMixin
  44. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  45. final def layerBoundaryMark: String

    Permalink
    Definition Classes
    LayeringAGMixin
  46. final def layerBoundaryMark_location: LookupLocation

    Permalink
    Definition Classes
    LayeringAGMixin
  47. final def layerEncoding: String

    Permalink
    Definition Classes
    LayeringAGMixin
  48. final def layerEncoding_location: LookupLocation

    Permalink
    Definition Classes
    LayeringAGMixin
  49. final def layerLength: String

    Permalink
    Definition Classes
    LayeringAGMixin
  50. final def layerLengthKind: LayerLengthKind

    Permalink
    Definition Classes
    LayerLengthKindMixin
  51. final def layerLengthKindInit(): Unit

    Permalink
    Definition Classes
    LayerLengthKindMixin
  52. final def layerLengthKindToString(): String

    Permalink

    This will print the property value if the property has any value in scope.

    This will print the property value if the property has any value in scope. This is mostly for debugging purposes.

    Definition Classes
    LayerLengthKindMixin
  53. final def layerLengthKind_location: LookupLocation

    Permalink
    Definition Classes
    LayerLengthKindMixin
  54. final def layerLengthUnits: LayerLengthUnits

    Permalink
    Definition Classes
    LayerLengthUnitsMixin
  55. final def layerLengthUnitsInit(): Unit

    Permalink
    Definition Classes
    LayerLengthUnitsMixin
  56. final def layerLengthUnitsToString(): String

    Permalink

    This will print the property value if the property has any value in scope.

    This will print the property value if the property has any value in scope. This is mostly for debugging purposes.

    Definition Classes
    LayerLengthUnitsMixin
  57. final def layerLengthUnits_location: LookupLocation

    Permalink
    Definition Classes
    LayerLengthUnitsMixin
  58. final def layerLength_location: LookupLocation

    Permalink
    Definition Classes
    LayeringAGMixin
  59. final def layerTransform: String

    Permalink
    Definition Classes
    LayeringAGMixin
  60. final def layerTransform_location: LookupLocation

    Permalink
    Definition Classes
    LayeringAGMixin
  61. def layeringAGInit(): Unit

    Permalink
    Definition Classes
    LayeringAGMixin
  62. final macro def log(lvl: Type, msg: String, args: Any*): Unit

    Permalink
    Definition Classes
    Logging
  63. lazy val logID: String

    Permalink
    Definition Classes
    LoggingIdentity
  64. var logLevel: Maybe[Type]

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

    Permalink
    Definition Classes
    Logging
  66. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  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 def optionChoiceLengthKind: Option[ChoiceLengthKind]

    Permalink
    Definition Classes
    ChoiceLengthKindMixin
  71. final def optionChoiceLengthKind_location: Option[LookupLocation]

    Permalink
    Definition Classes
    ChoiceLengthKindMixin
  72. final def optionLayerLengthKind: Option[LayerLengthKind]

    Permalink
    Definition Classes
    LayerLengthKindMixin
  73. final def optionLayerLengthKind_location: Option[LookupLocation]

    Permalink
    Definition Classes
    LayerLengthKindMixin
  74. final def optionLayerLengthUnits: Option[LayerLengthUnits]

    Permalink
    Definition Classes
    LayerLengthUnitsMixin
  75. final def optionLayerLengthUnits_location: Option[LookupLocation]

    Permalink
    Definition Classes
    LayerLengthUnitsMixin
  76. final def optionSeparatorPolicy: Option[SeparatorPolicy]

    Permalink
    Definition Classes
    SeparatorPolicyMixin
  77. final def optionSeparatorPolicy_location: Option[LookupLocation]

    Permalink
    Definition Classes
    SeparatorPolicyMixin
  78. final def optionSeparatorPosition: Option[SeparatorPosition]

    Permalink
    Definition Classes
    SeparatorPositionMixin
  79. final def optionSeparatorPosition_location: Option[LookupLocation]

    Permalink
    Definition Classes
    SeparatorPositionMixin
  80. final def optionSequenceKind: Option[SequenceKind]

    Permalink
    Definition Classes
    SequenceKindMixin
  81. final def optionSequenceKind_location: Option[LookupLocation]

    Permalink
    Definition Classes
    SequenceKindMixin
  82. val propCache: LinkedHashMap[String, PropertyLookupResult]

    Permalink
    Definition Classes
    FindPropertyMixin
  83. def registerToStringFunction(f: () ⇒ String): Unit

    Permalink
    Definition Classes
    PropertyMixin
  84. final def requireProperty(prop: PropertyLookupResult): Found

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

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

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

    Permalink

    SDE special case when we're blaming the error on the value of a property.

    SDE special case when we're blaming the error on the value of a property. If the location where the property value is defined is different from the current context, then we inform about both the context location, and the location where the property value comes from.

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

    Permalink

    * These functions are now macros as the original code: final def schemaDefinitionUnless(testThatWillThrowIfFalse: Boolean, str: => String, args: => Any*) = if (!testThatWillThrowIfFalse) SDE(str, args: _*) would cause expensive object allocation, even when the test would be true and even when the function was inlined

    * These functions are now macros as the original code: final def schemaDefinitionUnless(testThatWillThrowIfFalse: Boolean, str: => String, args: => Any*) = if (!testThatWillThrowIfFalse) SDE(str, args: _*) would cause expensive object allocation, even when the test would be true and even when the function was inlined

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

    Permalink

    Conditionally issue a warning.

    Conditionally issue a warning. The WarnID allows warning suppression.

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

    Permalink

    Conditionally issue a warning.

    Conditionally issue a warning. The WarnID allows warning suppression.

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

    Permalink
    Definition Classes
    ThrowsSDE
  92. def separatorAGInit(): Unit

    Permalink
    Definition Classes
    SeparatorAGMixin
  93. final def separatorPolicy: SeparatorPolicy

    Permalink
    Definition Classes
    SeparatorPolicyMixin
  94. final def separatorPolicyInit(): Unit

    Permalink
    Definition Classes
    SeparatorPolicyMixin
  95. final def separatorPolicyToString(): String

    Permalink

    This will print the property value if the property has any value in scope.

    This will print the property value if the property has any value in scope. This is mostly for debugging purposes.

    Definition Classes
    SeparatorPolicyMixin
  96. final def separatorPolicy_location: LookupLocation

    Permalink
    Definition Classes
    SeparatorPolicyMixin
  97. final def separatorPosition: SeparatorPosition

    Permalink
    Definition Classes
    SeparatorPositionMixin
  98. final def separatorPositionInit(): Unit

    Permalink
    Definition Classes
    SeparatorPositionMixin
  99. final def separatorPositionToString(): String

    Permalink

    This will print the property value if the property has any value in scope.

    This will print the property value if the property has any value in scope. This is mostly for debugging purposes.

    Definition Classes
    SeparatorPositionMixin
  100. final def separatorPosition_location: LookupLocation

    Permalink
    Definition Classes
    SeparatorPositionMixin
  101. def sequenceAGInit(): Unit

    Permalink
    Definition Classes
    SequenceAGMixin
  102. final def sequenceKind: SequenceKind

    Permalink
    Definition Classes
    SequenceKindMixin
  103. final def sequenceKindInit(): Unit

    Permalink
    Definition Classes
    SequenceKindMixin
  104. final def sequenceKindToString(): String

    Permalink

    This will print the property value if the property has any value in scope.

    This will print the property value if the property has any value in scope. This is mostly for debugging purposes.

    Definition Classes
    SequenceKindMixin
  105. final def sequenceKind_location: LookupLocation

    Permalink
    Definition Classes
    SequenceKindMixin
  106. def setLogWriter(lw: LogWriter): Unit

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

    Permalink
    Definition Classes
    Logging
  108. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  109. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  110. var toStringFunctionList: List[() ⇒ String]

    Permalink

    Properties will push their toString function onto this list

    Properties will push their toString function onto this list

    Each object that has any properties mixed in must implement this value.

    Definition Classes
    PropertyMixin
  111. final def toss(th: Throwable): Nothing

    Permalink

    Centralize throwing for debug convenience

    Centralize throwing for debug convenience

    Definition Classes
    ThrowsSDE
  112. def verboseToString: String

    Permalink

    prints all the properties on the object.

    prints all the properties on the object.

    Definition Classes
    PropertyMixin
  113. def verifyPropValue(key: String, value: String): Boolean

    Permalink

    For unit testing convenience, or for use when debugging.

    For unit testing convenience, or for use when debugging.

    Definition Classes
    FindPropertyMixin
  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. macro def withLoggingLevel[S](newLevel: Type = getLoggingLevel)(body: ⇒ S): Unit

    Permalink

    Use to make debug printing over small code regions convenient.

    Use to make debug printing over small code regions convenient. Turns on your logging level of choice over a lexical region of code. Makes sure it is reset to whatever it was on the exit, even if it throws.

    Call with no log level argument to turn it off (when done debugging). That way you can leave it sitting there.

    Definition Classes
    Logging

Inherited from SeparatorAGMixin

Inherited from SeparatorPolicyMixin

Inherited from SeparatorPositionMixin

Inherited from ChoiceAGMixin

Inherited from ChoiceLengthKindMixin

Inherited from ExtLayeringAGMixin

Inherited from LayeringAGMixin

Inherited from LayerLengthUnitsMixin

Inherited from LayerLengthKindMixin

Inherited from SequenceAGMixin

Inherited from SequenceKindMixin

Inherited from GroupCommonAGMixin

Inherited from PropertyMixin

Inherited from Logging

Inherited from Identity

Inherited from SavesErrorsAndWarnings

Inherited from ThrowsSDE

Inherited from FindPropertyMixin

Inherited from PropTypes

Inherited from AnyRef

Inherited from Any

Ungrouped