models

ExtractorInfo

case class ExtractorInfo(id: UUID, name: String, version: String, updated: Date = ..., description: String, author: String, contributors: List[String], contexts: JsValue, repository: List[Repository], external_services: List[String], libraries: List[String], bibtex: List[String], maturity: String = "Development", defaultLabels: List[String] = immutable.this.Nil, process: ExtractorProcessTriggers = ..., categories: List[String] = ..., parameters: JsValue = ...) extends Product with Serializable

Information about individual extractors. An extractor should set this the first time it starts up.

Modelled after node.js package.json

id

id internal to the system

name

lower case, no spaces, can use dashes

version

the version, for example 1.3.5

updated

date when this information was last updated

description

short description of what the extractor does

author

First Last <username@somedomain.org>

contributors

list of contributors with same format as author

contexts

the ids of the contexts defining the metadata uploaded by the extractors

repository

source code repository

external_services

external services used by the extractor

libraries

libraries on which the code depends

bibtex

bibtext formatted citation of relevant papers

maturity

indicates whether this extractor is ready for public consumption * For example: "Development" (default), "Staging", or "Production"

defaultLabels

the categorization label names that were imported by default * For example: "Image", "Video", "Audio", etc

process

events that should trigger this extractor to process

categories

list of categories that apply to the extractor

parameters

JSON schema representing allowed parameters which can contain the following fields (and more): * schema: {} a mapping of property key to type/title/validation data * form: [] ordered form fields keyed by properties defined in the schema

See also

See https://github.com/jsonform/jsonform/wiki for full documentation regarding parameters

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ExtractorInfo
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ExtractorInfo(id: UUID, name: String, version: String, updated: Date = ..., description: String, author: String, contributors: List[String], contexts: JsValue, repository: List[Repository], external_services: List[String], libraries: List[String], bibtex: List[String], maturity: String = "Development", defaultLabels: List[String] = immutable.this.Nil, process: ExtractorProcessTriggers = ..., categories: List[String] = ..., parameters: JsValue = ...)

    id

    id internal to the system

    name

    lower case, no spaces, can use dashes

    version

    the version, for example 1.3.5

    updated

    date when this information was last updated

    description

    short description of what the extractor does

    author

    First Last <username@somedomain.org>

    contributors

    list of contributors with same format as author

    contexts

    the ids of the contexts defining the metadata uploaded by the extractors

    repository

    source code repository

    external_services

    external services used by the extractor

    libraries

    libraries on which the code depends

    bibtex

    bibtext formatted citation of relevant papers

    maturity

    indicates whether this extractor is ready for public consumption * For example: "Development" (default), "Staging", or "Production"

    defaultLabels

    the categorization label names that were imported by default * For example: "Image", "Video", "Audio", etc

    process

    events that should trigger this extractor to process

    categories

    list of categories that apply to the extractor

    parameters

    JSON schema representing allowed parameters which can contain the following fields (and more): * schema: {} a mapping of property key to type/title/validation data * form: [] ordered form fields keyed by properties defined in the schema

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. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. val author: String

    First Last <username@somedomain.

    First Last <username@somedomain.org>

  8. val bibtex: List[String]

    bibtext formatted citation of relevant papers

  9. val categories: List[String]

    list of categories that apply to the extractor

  10. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. val contexts: JsValue

    the ids of the contexts defining the metadata uploaded by the extractors

  12. val contributors: List[String]

    list of contributors with same format as author

  13. val defaultLabels: List[String]

    the categorization label names that were imported by default * For example: "Image", "Video", "Audio", etc

  14. val description: String

    short description of what the extractor does

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

    Definition Classes
    AnyRef
  16. val external_services: List[String]

    external services used by the extractor

  17. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  19. val id: UUID

    id internal to the system

  20. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  21. val libraries: List[String]

    libraries on which the code depends

  22. val maturity: String

    indicates whether this extractor is ready for public consumption * For example: "Development" (default), "Staging", or "Production"

  23. val name: String

    lower case, no spaces, can use dashes

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

    Definition Classes
    AnyRef
  25. final def notify(): Unit

    Definition Classes
    AnyRef
  26. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  27. val parameters: JsValue

    JSON schema representing allowed parameters which can contain the following fields (and more): * schema: {} a mapping of property key to type/title/validation data * form: [] ordered form fields keyed by properties defined in the schema

  28. val process: ExtractorProcessTriggers

    events that should trigger this extractor to process

  29. val repository: List[Repository]

    source code repository

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

    Definition Classes
    AnyRef
  31. val updated: Date

    date when this information was last updated

  32. val version: String

    the version, for example 1.

    the version, for example 1.3.5

  33. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped