Packages

c

nl.knaw.dans.lib.dataverse

DataverseResponse

case class DataverseResponse[D] extends Product with Serializable

Encapsulates a response message from Dataverse. This is often, but not always, a JSON document. This class gives access to the response at the following levels as far as applicable (from lower to higher levels of abstraction): httpResponse, string, json, data.

For example if the response contains metadata about a dataset, you would use the data method to retrieve a model object that provides easy access to that structure. If JSON is returned but it is not modelled by a case class in nl.knaw.dans.lib.dataverse.model, then you could use the json method to get the json4s AST and query that to get to the information you need. If the body contains UTF-8 encoded plan text, use string. Finally, if the body contains binary data, use httpResponse.

D

the model object type that can be extracted (if none is available, this is set to Any).

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DataverseResponse
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. 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. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. def data: Try[D]

    The corresponding model object extracted from the body.

    The corresponding model object extracted from the body.

    See also

    nl.knaw.dans.lib.dataverse.model

  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. val httpResponse: HttpResponse[Array[Byte]]
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. def json: Try[JValue]

    The body of the response, decoded as a org.json4s.JValue.

  13. def message: Try[String]
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. def string: Try[String]

    The body of the response, decoded as UTF-8 string.

  18. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped