Class

com.ebiznext.comet.schema.model

Domain

Related Doc: package model

Permalink

case class Domain(name: String, directory: String, metadata: Option[Metadata] = None, schemas: List[Schema] = Nil, comment: Option[String] = None, extensions: Option[List[String]] = None, ack: Option[String] = None) extends Product with Serializable

Let's say you are wiling to import from you Sales system customers and orders. Sales is therefore the domain and cusomer & order are syour datasets.

name

: Domain name

directory

: Folder on the local filesystem where incomping files are stored. This folder will be scanned regurlaly to move the dataset to the cluster

metadata

: Default Schema meta data.

schemas

: List of schema for each dataset in this domain

comment

: Free text

extensions

: recognized filename extensions (json, csv, dsv, psv) are recognized by default

ack

: Ack extension used for each file

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Domain
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Domain(name: String, directory: String, metadata: Option[Metadata] = None, schemas: List[Schema] = Nil, comment: Option[String] = None, extensions: Option[List[String]] = None, ack: Option[String] = None)

    Permalink

    name

    : Domain name

    directory

    : Folder on the local filesystem where incomping files are stored. This folder will be scanned regurlaly to move the dataset to the cluster

    metadata

    : Default Schema meta data.

    schemas

    : List of schema for each dataset in this domain

    comment

    : Free text

    extensions

    : recognized filename extensions (json, csv, dsv, psv) are recognized by default

    ack

    : Ack extension used for each file

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

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

    Permalink
    Definition Classes
    AnyRef → Any

  4. val ack: Option[String]

    Permalink

    : Ack extension used for each file

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  6. def checkValidity(schemaHandler: SchemaHandler)(implicit settings: Settings): Either[List[String], Boolean]

    Permalink

    Is this Domain valid ? A domain is valid if :

    Is this Domain valid ? A domain is valid if :

    • The domain name is a valid attribute
    • all the schemas defined in this domain are valid
    • No schema is defined twice
    • Partitions columns are valid columns
    • The input directory is a valid path

  7. def clone(): AnyRef

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

  8. val comment: Option[String]

    Permalink

    : Free text

  9. val directory: String

    Permalink

    : Folder on the local filesystem where incomping files are stored.

    : Folder on the local filesystem where incomping files are stored. This folder will be scanned regurlaly to move the dataset to the cluster

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

    Permalink
    Definition Classes
    AnyRef

  11. val extensions: Option[List[String]]

    Permalink

    : recognized filename extensions (json, csv, dsv, psv) are recognized by default

  12. def finalize(): Unit

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

  13. def findSchema(filename: String): Option[Schema]

    Permalink

    Get schema from filename Schema are matched against filenames using filename patterns.

    Get schema from filename Schema are matched against filenames using filename patterns. The schema pattern thats matches the filename is returned

    filename

    : dataset filename

  14. def getAck(): String

    Permalink

    Ack file should be present for each file to ingest.

    Ack file should be present for each file to ingest.

    returns

    the ack attribute or ".ack" by default

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

    Permalink
    Definition Classes
    AnyRef → Any

  16. def getExtensions(): List[String]

    Permalink

    List of file extensions to scan for in the domain directory

    List of file extensions to scan for in the domain directory

    returns

    the list of extensions of teh default ones : ".json", ".csv", ".dsv", ".psv"

  17. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  18. def mapping(schema: Schema)(implicit settings: Settings): Option[String]

    Permalink

    Load Elasticsearch template file if it exist

    Load Elasticsearch template file if it exist

    schema

    : Schema name to map to an elasticsearch index

    returns

    ES template with optinnaly the PROPERTIES string that will be replaced by the schema attributes dynamically computed mappings

  19. val metadata: Option[Metadata]

    Permalink

    : Default Schema meta data.

  20. val name: String

    Permalink

    : Domain name

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

    Permalink
    Definition Classes
    AnyRef

  22. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  23. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  24. val schemas: List[Schema]

    Permalink

    : List of schema for each dataset in this domain

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

    Permalink
    Definition Classes
    AnyRef

  26. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped