Packages

  • package root
    Definition Classes
    root
  • package csw
    Definition Classes
    root
  • package params

    This project is intended to hold reusable models and params used throughout the csw source code.

    Params

    This project is intended to hold reusable models and params used throughout the csw source code.

    This also provides out of the box support to cater to the diverse communication requirements. Consumer of this library will be able to create Commands, Events, States to store ParameterSets.

    Imp Packages

    Commands and Events

    This packages contains classes, traits and models used to create *commands* and *events*. These are all based on type-safe keys and items (a set of values with optional units). Each key has a specific type and the key's values must be of that type.

    Two types of csw.params.commands.Command are supported:

    Following are the concrete commands supported by csw:

    Two types of csw.params.events.Event are supported:

    core

    This package supports serialization and deserialization of commands, events and state variables in JSON format csw.params.core.formats.JsonSupport.

    Scala and Java APIs

    All the param and event classes are immutable. The set methods return a new instance of the object with a new item added and the get methods return an Option, in case the Key is not found. There are also value methods that return a value directly, throwing an exception if the key or value is not found.

    Key Types

    A set of standard key types and matching items are defined. Each key accepts one or more values of the given type.

    Following csw.params.core.generics.KeyType are supported by csw:

    +--------------+-------------------------+---------------------------+
|  Primitive   |      Scala KeyType      |       Java KeyType        |
+--------------+-------------------------+---------------------------+
| Boolean      | KeyType.BooleanKey      | JKeyType.BooleanKey      |
| Character    | KeyType.CharKey         | JKeyType.JCharKey        |
| Byte         | KeyType.ByteKey         | JKeyType.ByteKey         |
| Short        | KeyType.ShortKey        | JKeyType.ShortKey        |
| Long         | KeyType.LongKey         | JKeyType.LongKey         |
| Int          | KeyType.IntKey          | JKeyType.IntKey          |
| Float        | KeyType.FloatKey        | JKeyType.FloatKey        |
| Double       | KeyType.DoubleKey       | JKeyType.DoubleKey       |
| String       | KeyType.StringKey       | JKeyType.StringKey       |
| Timestamp    | KeyType.TimestampKey    | JKeyType.TimestampKey    |
| ----------   | ----------              | ----------                |
| ByteArray    | KeyType.ByteArrayKey    | JKeyType.ByteArrayKey    |
| ShortArray   | KeyType.ShortArrayKey   | JKeyType.ShortArrayKey   |
| LongArray    | KeyType.LongArrayKey    | JKeyType.LongArrayKey    |
| IntArray     | KeyType.IntArrayKey     | JKeyType.IntArrayKey     |
| FloatArray   | KeyType.FloatArrayKey   | JKeyType.FloatArrayKey   |
| DoubleArray  | KeyType.DoubleArrayKey  | JKeyType.DoubleArrayKey  |
| ----------   | ----------              | ----------                |
| ByteMatrix   | KeyType.ByteMatrixKey   | JKeyType.ByteMatrixKey   |
| ShortMatrix  | KeyType.ShortMatrixKey  | JKeyType.ShortMatrixKey  |
| LongMatrix   | KeyType.LongMatrixKey   | JKeyType.LongMatrixKey   |
| IntMatrix    | KeyType.IntMatrixKey    | JKeyType.IntMatrixKey    |
| FloatMatrix  | KeyType.FloatMatrixKey  | JKeyType.FloatMatrixKey  |
| DoubleMatrix | KeyType.DoubleMatrixKey | JKeyType.DoubleMatrixKey |
| ----------   | ----------              | ----------                |
| Choice       | KeyType.ChoiceKey       | JKeyType.ChoiceKey       |
| RaDec        | KeyType.RaDecKey        | JKeyType.RaDecKey        |
| Struct       | KeyType.StructKey       | JKeyType.StructKey       |
+--------------+-------------------------+---------------------------+

    Detailed information about creating Keys and Parameters can be found here: https://tmtsoftware.github.io/csw/services/messages/keys-parameters.html

    Detailed information about creating commands can be found here: https://tmtsoftware.github.io/csw/services/messages/commands.html

    Detailed information about creating events can be found here: https://tmtsoftware.github.io/csw/services/messages/events.html

    Definition Classes
    csw
  • package core
    Definition Classes
    params
  • package formats
    Definition Classes
    core
  • AdtCbor
  • CborSupport
  • CommandCbor
  • EventCbor
  • JavaJsonSupport
  • JsonSupport
  • MiscJsonFormats
  • Timestamp

trait JsonSupport extends MiscJsonFormats

Supports conversion of commands, state variables and events to/from JSON

Linear Supertypes
MiscJsonFormats, AnyRef, Any
Known Subclasses
Result, JavaJsonSupport, JsonSupport, Struct
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JsonSupport
  2. MiscJsonFormats
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. implicit val booleanFormat: Format[Boolean]
    Definition Classes
    MiscJsonFormats
  6. implicit val byteFormat: Format[Byte]
    Definition Classes
    MiscJsonFormats
  7. implicit val charFormat: Format[Char]
    Definition Classes
    MiscJsonFormats
  8. implicit val characterFormat: Format[Character]
    Definition Classes
    MiscJsonFormats
  9. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate() @throws( ... )
  10. implicit val commandFormat: OFormat[Command]
  11. implicit val controlCommandFormat: Reads[ControlCommand]
  12. implicit val doubleFormat: Format[Double]
    Definition Classes
    MiscJsonFormats
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  15. implicit val eventFormat: OFormat[Event]
  16. implicit val floatFormat: Format[Float]
    Definition Classes
    MiscJsonFormats
  17. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. implicit val integerFormat: Format[Integer]
    Definition Classes
    MiscJsonFormats
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. implicit val longFormat: Format[Long]
    Definition Classes
    MiscJsonFormats
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  25. implicit def optionFormat[T](implicit arg0: Format[T]): Format[Option[T]]
    Definition Classes
    MiscJsonFormats
  26. implicit def parameterFormat2: Format[Parameter[_]]
    Definition Classes
    MiscJsonFormats
  27. def readEvent[A <: Event](json: JsValue): A

    Reads an event back from JSON

    Reads an event back from JSON

    A

    the type of the event (use Any and match on the type if you don't know)

    json

    the parsed JSON

    returns

    an instance of the given event type, or an exception if the JSON is not valid for that type

  28. def readResult(json: JsValue): Result

    Reads a Result back from JSON

    Reads a Result back from JSON

    json

    the parsed JSON

    returns

    an instance of Result, or an exception if the JSON is not valid for that type

  29. def readSequenceCommand[A <: Command](json: JsValue): A

    Reads a SequenceCommand back from JSON

    Reads a SequenceCommand back from JSON

    A

    the type of the command (implied)

    json

    the parsed JSON

    returns

    an instance of the given SequenceCommand type, or an exception if the JSON is not valid for that type

  30. def readStateVariable[A <: StateVariable](json: JsValue): A

    Reads a StateVariable back from JSON

    Reads a StateVariable back from JSON

    A

    the type of the StateVariable (implied)

    json

    the parsed JSON

    returns

    an instance of the given StateVariable, or an exception if the JSON is not valid for that type

  31. def reads[T](x: JsValue)(implicit arg0: Reads[T]): T
  32. implicit val sequenceCommandFormat: Reads[SequenceCommand]
  33. implicit val shortFormat: Format[Short]
    Definition Classes
    MiscJsonFormats
  34. implicit val stateVariableFormat: OFormat[StateVariable]
  35. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  36. implicit val timestampFormat: Format[Instant]
    Definition Classes
    MiscJsonFormats
  37. def toString(): String
    Definition Classes
    AnyRef → Any
  38. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  40. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. def writeEvent[A <: Event](event: A): JsValue

    Writes an event to JSON

    Writes an event to JSON

    A

    the type of the event (implied)

    event

    any instance of EventType

    returns

    a JsValue object representing the event

  42. def writeResult(result: Result): JsValue

    Writes a Result to JSON

    Writes a Result to JSON

    result

    any instance of Result

    returns

    a JsValue object representing the Result

  43. def writeSequenceCommand[A <: Command](result: A): JsValue

    Writes a SequenceParameterSet to JSON

    Writes a SequenceParameterSet to JSON

    A

    the type of the command (implied)

    result

    any instance of SequenceCommand

    returns

    a JsValue object representing the SequenceCommand

  44. def writeStateVariable[A <: StateVariable](stateVariable: A): JsValue

    Writes a state variable to JSON

    Writes a state variable to JSON

    A

    the type of the StateVariable (implied)

    stateVariable

    any instance of StateVariable

    returns

    a JsValue object representing the StateVariable

  45. def writes[T](x: T)(implicit arg0: Writes[T]): JsValue

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from MiscJsonFormats

Inherited from AnyRef

Inherited from Any

Ungrouped