Trait

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

CalendarFormatAGQualifiedMixin

Related Doc: package gen

Permalink

trait CalendarFormatAGQualifiedMixin extends PropertyMixin with CalendarPatternKindMixin with CalendarCheckPolicyMixin with CalendarFirstDayOfWeekMixin

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CalendarFormatAGQualifiedMixin
  2. CalendarFirstDayOfWeekMixin
  3. CalendarCheckPolicyMixin
  4. CalendarPatternKindMixin
  5. PropertyMixin
  6. Logging
  7. Identity
  8. SavesErrorsAndWarnings
  9. ThrowsSDE
  10. FindPropertyMixin
  11. PropTypes
  12. AnyRef
  13. 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. final def calendarCenturyStart: String

    Permalink
  9. final def calendarCenturyStart_location: LookupLocation

    Permalink
  10. final def calendarCheckPolicy: CalendarCheckPolicy

    Permalink
    Definition Classes
    CalendarCheckPolicyMixin
  11. final def calendarCheckPolicyInit(): Unit

    Permalink
    Definition Classes
    CalendarCheckPolicyMixin
  12. final def calendarCheckPolicyToString(): 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
    CalendarCheckPolicyMixin
  13. final def calendarCheckPolicy_location: LookupLocation

    Permalink
    Definition Classes
    CalendarCheckPolicyMixin
  14. final def calendarDaysInFirstWeek: String

    Permalink
  15. final def calendarDaysInFirstWeek_location: LookupLocation

    Permalink
  16. final def calendarFirstDayOfWeek: CalendarFirstDayOfWeek

    Permalink
    Definition Classes
    CalendarFirstDayOfWeekMixin
  17. final def calendarFirstDayOfWeekInit(): Unit

    Permalink
    Definition Classes
    CalendarFirstDayOfWeekMixin
  18. final def calendarFirstDayOfWeekToString(): 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
    CalendarFirstDayOfWeekMixin
  19. final def calendarFirstDayOfWeek_location: LookupLocation

    Permalink
    Definition Classes
    CalendarFirstDayOfWeekMixin
  20. def calendarFormatAGQualifiedInit(): Unit

    Permalink
  21. final def calendarObserveDST: YesNo

    Permalink
  22. final def calendarObserveDST_location: LookupLocation

    Permalink
  23. final def calendarPattern: String

    Permalink
  24. final def calendarPatternKind: CalendarPatternKind

    Permalink
    Definition Classes
    CalendarPatternKindMixin
  25. final def calendarPatternKindInit(): Unit

    Permalink
    Definition Classes
    CalendarPatternKindMixin
  26. final def calendarPatternKindToString(): 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
    CalendarPatternKindMixin
  27. final def calendarPatternKind_location: LookupLocation

    Permalink
    Definition Classes
    CalendarPatternKindMixin
  28. final def calendarPattern_location: LookupLocation

    Permalink
  29. final def calendarTimeZone: String

    Permalink
  30. final def calendarTimeZone_location: LookupLocation

    Permalink
  31. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. 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
  33. def convertToDouble(pv: String): Double

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

    Permalink
    Definition Classes
    PropertyMixin
  35. 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
  36. def convertToNCName(pv: String): String

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

    Permalink
    Definition Classes
    PropertyMixin
  38. 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
  39. def doLogging(lvl: Type, msg: String, args: Seq[Any]): Unit

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

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

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  44. 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
  45. def findPropertyOption(pname: String): PropertyLookupResult

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

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

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

    Permalink
    Definition Classes
    Logging
  49. 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
  50. 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
  51. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  52. final def isInstanceOf[T0]: Boolean

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

    Permalink
    Definition Classes
    Logging
  54. lazy val logID: String

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  61. final def optionCalendarCheckPolicy: Option[CalendarCheckPolicy]

    Permalink
    Definition Classes
    CalendarCheckPolicyMixin
  62. final def optionCalendarCheckPolicy_location: Option[LookupLocation]

    Permalink
    Definition Classes
    CalendarCheckPolicyMixin
  63. final def optionCalendarFirstDayOfWeek: Option[CalendarFirstDayOfWeek]

    Permalink
    Definition Classes
    CalendarFirstDayOfWeekMixin
  64. final def optionCalendarFirstDayOfWeek_location: Option[LookupLocation]

    Permalink
    Definition Classes
    CalendarFirstDayOfWeekMixin
  65. final def optionCalendarPatternKind: Option[CalendarPatternKind]

    Permalink
    Definition Classes
    CalendarPatternKindMixin
  66. final def optionCalendarPatternKind_location: Option[LookupLocation]

    Permalink
    Definition Classes
    CalendarPatternKindMixin
  67. val propCache: LinkedHashMap[String, PropertyLookupResult]

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

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

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

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

    Permalink
    Definition Classes
    SavesErrorsAndWarnings
  72. 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
  73. 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
  74. 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
  75. 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
  76. final macro def schemaDefinitionWhen(testThatWillThrowIfTrue: Boolean, str: String, args: Any*): Unit

    Permalink
    Definition Classes
    ThrowsSDE
  77. def setLogWriter(lw: LogWriter): Unit

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  81. 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
  82. final def toss(th: Throwable): Nothing

    Permalink

    Centralize throwing for debug convenience

    Centralize throwing for debug convenience

    Definition Classes
    ThrowsSDE
  83. def verboseToString: String

    Permalink

    prints all the properties on the object.

    prints all the properties on the object.

    Definition Classes
    PropertyMixin
  84. 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
  85. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  88. 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 CalendarCheckPolicyMixin

Inherited from CalendarPatternKindMixin

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