com.opendatagroup.hadrian.data

PFAMap

class PFAMap[X <: AnyRef] extends Map[String, X]

Represents all maps in PFA (generic or specific).

Data are stored in an immutable Scala Map, which is either created directly by the PFAMap.fromMap companion object method or filled by Avro (see below).

Primitives should be typed in Scala as boxed primitives (e.g. PFAArray[java.lang.Integer], not PFAArray[Int]).

To interact with the Avro library, a PFAMap satisfies the java.util.Map contract, but only minimally (most methods throw NotImplementedException).

It has two stages:

The toMap method should be considered lightweight (the backing Map is only created once).

Linear Supertypes
Map[String, X], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. PFAMap
  2. Map
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new PFAMap(builder: Builder[(String, X), Map[String, X]], map: Map[String, X])

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. def apply(i: String): X

    Calls toMap.apply(i).

  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  8. def clear(): Unit

    Raises NotImplementedError.

    Raises NotImplementedError.

    Definition Classes
    PFAMap → Map

  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  10. def compute(arg0: String, arg1: BiFunction[_ >: String, _ >: X, _ <: X]): X

    Definition Classes
    Map

  11. def computeIfAbsent(arg0: String, arg1: Function[_ >: String, _ <: X]): X

    Definition Classes
    Map

  12. def computeIfPresent(arg0: String, arg1: BiFunction[_ >: String, _ >: X, _ <: X]): X

    Definition Classes
    Map

  13. def containsKey(key: AnyRef): Boolean

    Raises NotImplementedError.

    Raises NotImplementedError.

    Definition Classes
    PFAMap → Map

  14. def containsValue(value: AnyRef): Boolean

    Raises NotImplementedError.

    Raises NotImplementedError.

    Definition Classes
    PFAMap → Map

  15. def converted[X](elem: X, schema: Schema): X

    Helper function to ensure that numerical types are exactly right (int for int, long for long, etc.

    Helper function to ensure that numerical types are exactly right (int for int, long for long, etc.).

    elem

    datum to convert

    schema

    schema to convert it to

    returns

    converted datum (boxed primitives)

  16. def entrySet(): Set[Entry[String, X]]

    One of only three java.util.Map methods that have been implemented (needed for filling in the Avro library).

    One of only three java.util.Map methods that have been implemented (needed for filling in the Avro library).

    Definition Classes
    PFAMap → Map

  17. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  18. def equals(that: Any): Boolean

    Definition Classes
    PFAMap → Map → AnyRef → Any

  19. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  20. def forEach(arg0: BiConsumer[_ >: String, _ >: X]): Unit

    Definition Classes
    Map

  21. def get(key: AnyRef): X

    One of only three java.util.Map methods that have been implemented (needed for filling in the Avro library).

    One of only three java.util.Map methods that have been implemented (needed for filling in the Avro library).

    Definition Classes
    PFAMap → Map

  22. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  23. def getOrDefault(arg0: Any, arg1: X): X

    Definition Classes
    Map

  24. def hashCode(): Int

    Definition Classes
    PFAMap → Map → AnyRef → Any

  25. def isEmpty(): Boolean

    Raises NotImplementedError.

    Raises NotImplementedError.

    Definition Classes
    PFAMap → Map

  26. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  27. def keySet(): Set[String]

    Raises NotImplementedError.

    Raises NotImplementedError.

    Definition Classes
    PFAMap → Map

  28. def merge(arg0: String, arg1: X, arg2: BiFunction[_ >: X, _ >: X, _ <: X]): X

    Definition Classes
    Map

  29. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  30. final def notify(): Unit

    Definition Classes
    AnyRef

  31. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  32. def put(key: String, value: X): X

    One of only three java.util.Map methods that have been implemented (needed for filling in the Avro library).

    One of only three java.util.Map methods that have been implemented (needed for filling in the Avro library).

    Definition Classes
    PFAMap → Map

  33. def putAll(that: Map[_ <: String, _ <: X]): Unit

    Raises NotImplementedError.

    Raises NotImplementedError.

    Definition Classes
    PFAMap → Map

  34. def putIfAbsent(arg0: String, arg1: X): X

    Definition Classes
    Map

  35. def remove(key: AnyRef): X

    Raises NotImplementedError.

    Raises NotImplementedError.

    Definition Classes
    PFAMap → Map

  36. def remove(arg0: Any, arg1: Any): Boolean

    Definition Classes
    Map

  37. def replace(arg0: String, arg1: X): X

    Definition Classes
    Map

  38. def replace(arg0: String, arg1: X, arg2: X): Boolean

    Definition Classes
    Map

  39. def replaceAll(arg0: BiFunction[_ >: String, _ >: X, _ <: X]): Unit

    Definition Classes
    Map

  40. def size(): Int

    Raises NotImplementedError.

    Raises NotImplementedError.

    Definition Classes
    PFAMap → Map

  41. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  42. def toMap: Map[String, X]

    Access the Scala Map behind this PFAMap.

    Access the Scala Map behind this PFAMap.

    After the first call to this function, it references a cached Map.

  43. def toString(): String

    Definition Classes
    PFAMap → AnyRef → Any

  44. def updated[Y](path: List[PathIndex], updator: (Y) ⇒ Y, schema: Schema): PFAMap[X]

    Returns an updated copy of this PFAArray (and its substructures) with a deep element replaced.

    Returns an updated copy of this PFAArray (and its substructures) with a deep element replaced.

    path

    coordinates of the deep element to have replaced

    updator

    function that replaces the old value with a new one

    schema

    schema of the subelement

    returns

    new PFAArray, leaving the old one untouched

  45. def updated[Y](path: Array[PathIndex], updator: (Y) ⇒ Y, schema: Schema, arrayErrStr: String, arrayErrCode: Int, mapErrStr: String, mapErrCode: Int, fcnName: String, pos: Option[String]): PFAMap[X]

    Returns an updated copy of this PFAArray (and its substructures) with a deep element replaced.

    Returns an updated copy of this PFAArray (and its substructures) with a deep element replaced.

    path

    coordinates of the deep element to have replaced

    updator

    function that replaces the old value with a new one

    schema

    schema of the subelement

    arrayErrStr

    error message if an array path index is wrong

    arrayErrCode

    error code if an array path index is wrong

    mapErrStr

    error message if a map path index is wrong

    mapErrCode

    error code if a map path index is wrong

    fcnName

    name of the calling PFA function

    pos

    locator mark for the calling PFA function

    returns

    new PFAArray, leaving the old one untouched

  46. def updated[Y](path: Array[PathIndex], updator: (Y) ⇒ Y, schema: Schema): PFAMap[X]

    Returns an updated copy of this PFAMap (and its substructures) with a deep element replaced.

    Returns an updated copy of this PFAMap (and its substructures) with a deep element replaced.

    path

    coordinates of the deep element to have replaced

    schema

    schema of the subelement

    returns

    new PFAMap, leaving the old one untouched

  47. def updated(path: Array[PathIndex], elem: X, schema: Schema, arrayErrStr: String, arrayErrCode: Int, mapErrStr: String, mapErrCode: Int, fcnName: String, pos: Option[String]): PFAMap[X]

    Returns an updated copy of this PFAMap (and its substructures) with a deep element replaced.

    Returns an updated copy of this PFAMap (and its substructures) with a deep element replaced.

    path

    coordinates of the deep element to have replaced

    elem

    new value for the subelement

    schema

    schema of the subelement

    arrayErrStr

    error message if an array path index is wrong

    arrayErrCode

    error code if an array path index is wrong

    mapErrStr

    error message if a map path index is wrong

    mapErrCode

    error code if a map path index is wrong

    fcnName

    name of the calling PFA function

    pos

    locator mark for the calling PFA function

    returns

    new PFAMap, leaving the old one untouched

  48. def updated(path: Array[PathIndex], elem: X, schema: Schema): PFAMap[X]

    Returns an updated copy of this PFAMap (and its substructures) with a deep element replaced.

    Returns an updated copy of this PFAMap (and its substructures) with a deep element replaced.

    path

    coordinates of the deep element to have replaced

    elem

    new value for the subelement

    schema

    schema of the subelement

    returns

    new PFAMap, leaving the old one untouched

  49. def updated(path: List[PathIndex], elem: X, schema: Schema): PFAMap[X]

    Returns an updated copy of this PFAMap (and its substructures) with a deep element replaced.

    Returns an updated copy of this PFAMap (and its substructures) with a deep element replaced.

    path

    coordinates of the deep element to have replaced

    elem

    new value for the subelement

    schema

    schema of the subelement

    returns

    new PFAMap, leaving the old one untouched

  50. def updated(i: String, elem: X, schema: Schema): PFAMap[X]

    Returns an updated copy of this PFAMap with one element replaced.

    Returns an updated copy of this PFAMap with one element replaced.

    i

    key of element to have replaced

    elem

    new value for element

    schema

    schema of element

    returns

    new PFAMap, leaving the old one untouched

  51. def values(): Collection[X]

    Raises NotImplementedError.

    Raises NotImplementedError.

    Definition Classes
    PFAMap → Map

  52. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  53. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  54. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Map[String, X]

Inherited from AnyRef

Inherited from Any

Ungrouped