ExtractorInfo

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

Instance Constructors

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 = ..., unique_key: Option[String] = scala.None, permissions: List[ResourceRef] = immutable.this.Nil)

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

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
val author: String

First Last <username@somedomain.
First Last <username@somedomain.org>
val bibtex: List[String]

bibtext formatted citation of relevant papers
val categories: List[String]

list of categories that apply to the extractor
def clone(): AnyRef

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

the ids of the contexts defining the metadata uploaded by the extractors
val contributors: List[String]

list of contributors with same format as author
val defaultLabels: List[String]

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

short description of what the extractor does
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val external_services: List[String]

external services used by the extractor
def finalize(): Unit

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

Definition Classes
AnyRef → Any
val id: UUID

id internal to the system
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val libraries: List[String]

libraries on which the code depends
val maturity: String

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

lower case, no spaces, can use dashes
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
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
val permissions: List[ResourceRef]
val process: ExtractorProcessTriggers

events that should trigger this extractor to process
val repository: List[Repository]

source code repository
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val unique_key: Option[String]
val updated: Date

date when this information was last updated
val version: String

the version, for example 1.
the version, for example 1.3.5
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Instance Constructors

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

val author: String

val bibtex: List[String]

val categories: List[String]

def clone(): AnyRef

val contexts: JsValue

val contributors: List[String]

val defaultLabels: List[String]

val description: String

final def eq(arg0: AnyRef): Boolean

val external_services: List[String]

def finalize(): Unit

final def getClass(): Class[_]

val id: UUID

final def isInstanceOf[T0]: Boolean

val libraries: List[String]

val maturity: String

val name: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val parameters: JsValue

val permissions: List[ResourceRef]

val process: ExtractorProcessTriggers

val repository: List[Repository]

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

val unique_key: Option[String]

val updated: Date

val version: String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped