t

io.idml

IdmlArray

trait IdmlArray extends IdmlValue with CompositeValue

A structure that has array-like behaviour

Linear Supertypes
CompositeValue, IdmlValue, ArrayModule, RegexModule, MathsModule, EmailModule, DateModule, UrlModule, ObjectModule, StringModule, NavigationModule, SchemaModule, AnyRef, Any
Known Subclasses
IArray
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. IdmlArray
  2. CompositeValue
  3. IdmlValue
  4. ArrayModule
  5. RegexModule
  6. MathsModule
  7. EmailModule
  8. DateModule
  9. UrlModule
  10. ObjectModule
  11. StringModule
  12. NavigationModule
  13. SchemaModule
  14. AnyRef
  15. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def items: Buffer[IdmlValue]

    The underlying items array

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def *(target: IdmlValue): IdmlValue
    Definition Classes
    MathsModule
  4. def +(target: IdmlValue): IdmlValue
    Definition Classes
    MathsModule
  5. def -(target: IdmlValue): IdmlValue
    Definition Classes
    MathsModule
  6. def /(target: IdmlValue): IdmlValue
    Definition Classes
    MathsModule
  7. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def abs(): IdmlValue
    Definition Classes
    MathsModule
  9. def array(): IdmlValue

    Transform this field into an array

    Transform this field into an array

    Definition Classes
    SchemaModule
  10. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  11. def average(): IdmlValue
    Definition Classes
    ArrayModule
  12. def bool(): IdmlValue

    Transform this field into a boolean

    Transform this field into a boolean

    Definition Classes
    SchemaModule
  13. def capitalize(): IdmlValue
    Definition Classes
    StringModule
  14. def ceil(): IdmlValue
    Definition Classes
    MathsModule
  15. def ceil(sd: IdmlValue): IdmlValue
    Definition Classes
    MathsModule
  16. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  17. def combinations(size: IdmlValue): IdmlValue
    Definition Classes
    ArrayModule
  18. def combineAll(): IdmlValue
    Definition Classes
    ArrayModule
  19. def date(formatStr: IdmlValue): IdmlValue

    formatStr

    a date format string which will be used to interpret the value of this date

    returns

    BadDateFormat if the date format is invalid, CastFailed if parsing the date failed for another reason or a io.idml.datanodes.IDate representing the results of what was parsed

    Definition Classes
    DateModule
    See also

    java.text.SimpleDateFormat

  20. def date(): IdmlValue

    Try to cast something into a date

    Try to cast something into a date

    Definition Classes
    DateModule
  21. def dateToString(df: DateTimeFormatter)(d: IDate): String
    Definition Classes
    DateModule
  22. def deepCopy: IdmlValue

    Create a new version of this object that can be safely modified by other callers

    Create a new version of this object that can be safely modified by other callers

    Definition Classes
    SchemaModule
  23. def default(value: IdmlValue): IdmlValue

    If the value is missing then use a default value instead

    If the value is missing then use a default value instead

    Definition Classes
    SchemaModule
  24. def deleted(): IdmlValue
    Definition Classes
    NavigationModule
  25. def diff(other: IdmlValue): IdmlValue
    Definition Classes
    ArrayModule
  26. def double(): IdmlValue

    Transform this field into a float

    Transform this field into a float

    Definition Classes
    SchemaModule
  27. def email(): IdmlValue

    Construct a new Email by parsing a string

    Construct a new Email by parsing a string

    Definition Classes
    EmailModule
  28. def empty(): IdmlValue
    Definition Classes
    ArrayModule
  29. def enumerate(): IdmlValue
    Definition Classes
    ArrayModule
  30. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. def equals(o: Any): Boolean

    Compare the items in this array to another array

    Compare the items in this array to another array

    Definition Classes
    IdmlArray → AnyRef → Any
  32. def exp(): IdmlValue
    Definition Classes
    MathsModule
  33. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  34. def flatten(depth: IdmlValue): IdmlValue
    Definition Classes
    ArrayModule
  35. def flatten(): IdmlValue
    Definition Classes
    ArrayModule
  36. def float(): IdmlValue

    Transform this field into a floating-point number

    Transform this field into a floating-point number

    Definition Classes
    SchemaModule
  37. def floor(): IdmlValue
    Definition Classes
    MathsModule
  38. def floor(sd: IdmlValue): IdmlValue
    Definition Classes
    MathsModule
  39. def format(varargs: IdmlValue*): IdmlValue

    Format strings

    Format strings

    Definition Classes
    StringModule
  40. def formatValue: Buffer[IdmlValue]
  41. def get(index: Int): IdmlValue

    Get an item by its index

    Get an item by its index

    Definition Classes
    IdmlArray → NavigationModule
  42. def get(index: IdmlValue): IdmlValue

    It's possible to get an item by its index

    It's possible to get an item by its index

    Definition Classes
    IdmlArray → NavigationModule
  43. def get(name: String): IdmlValue

    Fetch a field by name

    Fetch a field by name

    Definition Classes
    NavigationModule
  44. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  45. def hashCode(): Int

    Return the hashcode for this array.

    Return the hashcode for this array. Equal to the underlying items array

    Definition Classes
    IdmlArray → AnyRef → Any
  46. def indexOf(value: IdmlValue): IdmlValue

    Find the index of an item

    Find the index of an item

    Definition Classes
    IdmlArray → NavigationModule
  47. def int(): IdmlValue

    Transform this field into a natural number

    Transform this field into a natural number

    Definition Classes
    SchemaModule
  48. def intersect(other: IdmlValue): IdmlValue
    Definition Classes
    ArrayModule
  49. def isArray: IBool

    Is this an array?

    Is this an array?

    Definition Classes
    SchemaModule
  50. def isEmpty: IBool

    Is the array empty?

    Is the array empty?

    Definition Classes
    IdmlArray → SchemaModule
  51. def isFalse: IBool

    Is this false?

    Is this false?

    Definition Classes
    SchemaModule
  52. def isFalseValue: Boolean

    Is this false?

    Is this false?

    Definition Classes
    SchemaModule
  53. def isFloat: IBool

    Is this a float?

    Is this a float?

    Definition Classes
    SchemaModule
  54. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  55. def isInt: IBool

    Is this an int?

    Is this an int?

    Definition Classes
    SchemaModule
  56. def isMatch(regex: IdmlValue): IdmlValue
    Definition Classes
    RegexModule
  57. def isNothing: IBool

    Is this value nothing?

    Is this value nothing?

    Definition Classes
    SchemaModule
  58. def isNothingValue: Boolean

    Is this value nothing?

    Is this value nothing?

    Definition Classes
    SchemaModule
  59. def isNull: IBool

    Is this value null?

    Is this value null?

    Definition Classes
    SchemaModule
  60. def isNullValue: Boolean

    Is this value null?

    Is this value null?

    Definition Classes
    SchemaModule
  61. def isObject: IBool

    Is this an object?

    Is this an object?

    Definition Classes
    SchemaModule
  62. def isString: IBool

    Is this a string?

    Is this a string?

    Definition Classes
    SchemaModule
  63. def isStringValue: Boolean

    Is this a string?

    Is this a string?

    Definition Classes
    SchemaModule
  64. def isTrue: IBool

    Is this true?

    Is this true?

    Definition Classes
    SchemaModule
  65. def isTrueValue: Boolean

    Is this true?

    Is this true?

    Definition Classes
    SchemaModule
  66. def iterator: Iterator[IdmlValue]

    Iterate over the sub-components of this node

    Iterate over the sub-components of this node

    Definition Classes
    SchemaModule
  67. def keys(): IdmlValue
    Definition Classes
    ObjectModule
  68. def log(): IdmlValue
    Definition Classes
    MathsModule
  69. def lowercase(): IdmlValue

    Make a string lowercase

    Make a string lowercase

    Definition Classes
    StringModule
  70. def match(regex: IdmlValue): IdmlValue
    Definition Classes
    RegexModule
  71. def matches(regex: IdmlValue): IdmlValue
    Definition Classes
    RegexModule
  72. def max(): IdmlValue
    Definition Classes
    ArrayModule
  73. def median(): IdmlValue
    Definition Classes
    ArrayModule
  74. def microtime(): IdmlValue

    The current time in microseconds

    The current time in microseconds

    Definition Classes
    DateModule
  75. def millis(): IdmlValue
    Definition Classes
    DateModule
  76. def min(): IdmlValue
    Definition Classes
    ArrayModule
  77. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  78. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  79. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  80. def now(): IdmlValue

    The current date

    The current date

    Definition Classes
    DateModule
  81. def object(): IdmlValue

    Transform this field into an object

    Transform this field into an object

    Definition Classes
    SchemaModule
  82. def orElse(value: IdmlValue): IdmlValue
    Definition Classes
    SchemaModule
  83. def parseHex(): IdmlValue
    Definition Classes
    MathsModule
  84. def parseHexUnsigned(): IdmlValue
    Definition Classes
    MathsModule
  85. def pow(e: IdmlValue): IdmlValue
    Definition Classes
    MathsModule
  86. def remove(path: String): Unit

    Remove a field by name

    Remove a field by name

    Definition Classes
    ObjectModule
  87. final def remove(path: List[String]): Unit

    Nested path removal.

    Nested path removal. Will leave empty arrays and objects lingering

    Definition Classes
    NavigationModule
    Annotations
    @tailrec()
  88. final def removeWithoutEmpty(path: List[String]): Unit

    Remove a path.

    Remove a path. Will remove empty arrays and objects

    Definition Classes
    NavigationModule
  89. def replace(regex: IdmlValue, replacement: IdmlValue): IdmlValue
    Definition Classes
    RegexModule
  90. def required(): IdmlValue

    Annotate any missing fields.

    Annotate any missing fields. This is useful later on for processes like schema matching

    Definition Classes
    SchemaModule
  91. def round(): IdmlValue
    Definition Classes
    MathsModule
  92. def round(sd: IdmlValue): IdmlValue
    Definition Classes
    MathsModule
  93. def rssDate(): IdmlValue
    Definition Classes
    DateModule
  94. def sigfig(sd: IdmlValue): IdmlValue
    Definition Classes
    MathsModule
  95. def size: Int

    Get the number of items in the array

  96. def slice(from: Option[Int], to: Option[Int]): IdmlArray

    Get items within an index range slice slice

    Get items within an index range slice slice

    Definition Classes
    IdmlArray → NavigationModule
  97. def slice(from: IdmlValue, to: IdmlValue): IdmlValue

    Slice can be called by users

    Slice can be called by users

    Definition Classes
    NavigationModule
  98. def softmax(): IdmlValue
    Definition Classes
    ArrayModule
  99. def sort(): IdmlValue
    Definition Classes
    ArrayModule
  100. def specificDate(df: DateTimeFormatter): IdmlValue
    Definition Classes
    DateModule
  101. def split(delim: IdmlValue): IdmlValue
    Definition Classes
    RegexModule
  102. def sqrt(): IdmlValue
    Definition Classes
    MathsModule
  103. def stdDev(): IdmlValue
    Definition Classes
    ArrayModule
  104. def string(): IdmlValue

    Transform this node to a string

    Transform this node to a string

    Definition Classes
    StringModule
  105. def strip(): IdmlValue
    Definition Classes
    StringModule
  106. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  107. def timezone(tz: IdmlValue): IdmlValue
    Definition Classes
    DateModule
  108. def toBoolOption: Option[Boolean]

    Extract the underlying boolean value for this node if it has one, otherwise return none

    Extract the underlying boolean value for this node if it has one, otherwise return none

    Definition Classes
    SchemaModule
  109. def toBoolValue: Boolean

    Extract the underlying boolean value for this node if it has one, otherwise return a default

    Extract the underlying boolean value for this node if it has one, otherwise return a default

    Definition Classes
    SchemaModule
  110. def toDoubleOption: Option[Double]

    Extract the underlying double value for this node if it has one, otherwise return none

    Extract the underlying double value for this node if it has one, otherwise return none

    Definition Classes
    SchemaModule
  111. def toDoubleValue: Double

    Extract the underlying double value for this node if it has one, otherwise return a default

    Extract the underlying double value for this node if it has one, otherwise return a default

    Definition Classes
    SchemaModule
  112. def toEpoch(): IdmlValue
    Definition Classes
    DateModule
  113. def toEpochMillis(): IdmlValue
    Definition Classes
    DateModule
  114. def toFloatOption: Option[Float]

    Extract the underlying float value for this node if it has one, otherwise return none

    Extract the underlying float value for this node if it has one, otherwise return none

    Definition Classes
    SchemaModule
  115. def toFloatValue: Float

    Extract the underlying float value for this node if it has one, otherwise return a default

    Extract the underlying float value for this node if it has one, otherwise return a default

    Definition Classes
    SchemaModule
  116. def toIntOption: Option[Int]

    Extract the underlying int value for this node if it has one, otherwise return none

    Extract the underlying int value for this node if it has one, otherwise return none

    Definition Classes
    SchemaModule
  117. def toIntValue: Int

    Extract the underlying int value for this node if it has one, otherwise return a default

    Extract the underlying int value for this node if it has one, otherwise return a default

    Definition Classes
    SchemaModule
  118. def toLongOption: Option[Long]

    Extract the underlying long value for this node if it has one, otherwise return none

    Extract the underlying long value for this node if it has one, otherwise return none

    Definition Classes
    SchemaModule
  119. def toLongValue: Long

    Extract the underlying long value for this node if it has one, otherwise return a default

    Extract the underlying long value for this node if it has one, otherwise return a default

    Definition Classes
    SchemaModule
  120. def toString(): String
    Definition Classes
    AnyRef → Any
  121. def toStringOption: Option[String]

    Extract the underlying string value for this node if it has one, otherwise return none

    Extract the underlying string value for this node if it has one, otherwise return none

    Definition Classes
    IdmlArray → SchemaModule
  122. def toStringValue: String

    Extract the underlying string value for this node if it has one, otherwise return a default

    Extract the underlying string value for this node if it has one, otherwise return a default

    Definition Classes
    SchemaModule
  123. def union(other: IdmlValue): IdmlValue
    Definition Classes
    ArrayModule
  124. def unique(): IdmlValue
    Definition Classes
    ArrayModule
  125. def uppercase(): IdmlValue

    Make a string uppercase

    Make a string uppercase

    Definition Classes
    StringModule
  126. def url(): IdmlValue

    Construct a new URL by parsing a string

    Construct a new URL by parsing a string

    Definition Classes
    UrlModule
  127. def urls(): IdmlValue
    Definition Classes
    UrlModule
  128. def values(): IdmlValue
    Definition Classes
    ObjectModule
  129. def variance(): IdmlValue
    Definition Classes
    ArrayModule
  130. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  131. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  132. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  133. def wrapArray(): IArray
    Definition Classes
    ArrayModule
  134. def wrapIndex(index: Int, size: Int): Int

    Wrap an index so we can support negatives but overflows should always return nothing

    Wrap an index so we can support negatives but overflows should always return nothing

    Attributes
    protected
  135. def zip(other: IdmlValue): IdmlValue
    Definition Classes
    ArrayModule

Inherited from CompositeValue

Inherited from IdmlValue

Inherited from ArrayModule

Inherited from RegexModule

Inherited from MathsModule

Inherited from EmailModule

Inherited from DateModule

Inherited from UrlModule

Inherited from ObjectModule

Inherited from StringModule

Inherited from NavigationModule

Inherited from SchemaModule

Inherited from AnyRef

Inherited from Any

Ungrouped