c

bigglue.store

DataStore

abstract class DataStore[Data] extends Upstream[Data] with ConfigChecker with ConfigBuildsDataStore

The Data Store is an abstraction for how you store your data in BigGlue. Within Data Stores, you have DataMap, DataMultiMap, and DataQueue from a list of most useful to least useful within BigGlue. Within the example, all of the data stores are bigglue.store.instances.solr.SolrDataMaps.

Data

The type of the data that is intended to be put into the data store. In this case, it's bigglue.examples.GitID for gitID, bigglue.examples.GitRepo for clonedMap, bigglue.examples.GitCommitInfo for commitInfoMap, and bigglue.examples.GitCommitGroups for authorMap.

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DataStore
  2. ConfigBuildsDataStore
  3. ConfigBuilds
  4. ConfigChecker
  5. Upstream
  6. AnyRef
  7. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DataStore()

Abstract Value Members

  1. abstract def all(): Seq[Data]

    This gets everything from the data store.

    This gets everything from the data store.

    returns

    Every document that is stored in the data store.

  2. abstract def extract(): Seq[Data]
  3. abstract def iterator(): Iterator[Data]

    This returns an iterator that iterates over the data store.

    This returns an iterator that iterates over the data store.

    returns

    An iterator that iterates over the data store until all documents have been processed.

  4. abstract def put_(data: Seq[Data]): Unit

    This actually puts the data into the data store.

    This actually puts the data into the data store.

    data

    The data to be put into the data store.

  5. abstract def size(): Int

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from DataStore[Data] to any2stringadd[DataStore[Data]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (DataStore[Data], B)
    Implicit
    This member is added by an implicit conversion from DataStore[Data] to ArrowAssoc[DataStore[Data]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def add(data: Data): Unit
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def checkConfig(conf: PipeConfig): Unit

    Check that paths in configuration file relevant to host class are well-formed.

    Check that paths in configuration file relevant to host class are well-formed. Default does nothing.

    conf

    the config file to check

    Definition Classes
    ConfigChecker
  9. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. val configOpt: Option[PipeConfig]
    Definition Classes
    ConfigBuilds
  11. def constructBuilder(config: PipeConfig): DataStoreBuilder
    Definition Classes
    ConfigBuildsDataStoreConfigBuilds
  12. def displayName(): String
  13. val downstreamConnectors: Seq[Connector[Data]]
    Definition Classes
    Upstream
  14. def ensuring(cond: (DataStore[Data]) ⇒ Boolean, msg: ⇒ Any): DataStore[Data]
    Implicit
    This member is added by an implicit conversion from DataStore[Data] to Ensuring[DataStore[Data]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: (DataStore[Data]) ⇒ Boolean): DataStore[Data]
    Implicit
    This member is added by an implicit conversion from DataStore[Data] to Ensuring[DataStore[Data]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: Boolean, msg: ⇒ Any): DataStore[Data]
    Implicit
    This member is added by an implicit conversion from DataStore[Data] to Ensuring[DataStore[Data]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: Boolean): DataStore[Data]
    Implicit
    This member is added by an implicit conversion from DataStore[Data] to Ensuring[DataStore[Data]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  20. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  21. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from DataStore[Data] to StringFormat[DataStore[Data]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  22. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  23. def getConfig(config: PipeConfig): PipeConfig
    Definition Classes
    ConfigBuilds
  24. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  25. def init(conf: PipeConfig): Unit
  26. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  27. var name: String
  28. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. final def notify(): Unit
    Definition Classes
    AnyRef
  30. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  31. def put(data: Data): Unit
  32. def put(data: Seq[Data]): Unit

    This puts the data into the data store using put_, and then sends the data down the pipeline if the data store is connected to the pipeline.

    This puts the data into the data store using put_, and then sends the data down the pipeline if the data store is connected to the pipeline.

    data

    The data that needs to be put into the data store.

  33. def registerConnector(connector: Connector[Data]): Unit
    Definition Classes
    Upstream
  34. def setConfig(pipeConfig: PipeConfig): Unit
    Definition Classes
    ConfigBuilds
  35. def setName(newName: String): Unit
  36. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  37. def terminate(): Unit
  38. def toString(): String
    Definition Classes
    AnyRef → Any
  39. def transmitDownstream(data: Data): Unit
    Definition Classes
    Upstream
  40. def transmitDownstream(data: Seq[Data]): Unit
    Definition Classes
    Upstream
  41. def transmitDownstreamModified(data: Data): Unit
    Definition Classes
    Upstream
  42. def transmitDownstreamModified(data: Seq[Data]): Unit
    Definition Classes
    Upstream
  43. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  44. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  45. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  46. def [B](y: B): (DataStore[Data], B)
    Implicit
    This member is added by an implicit conversion from DataStore[Data] to ArrowAssoc[DataStore[Data]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from ConfigBuildsDataStore

Inherited from ConfigBuilds[DataStoreBuilder]

Inherited from ConfigChecker

Inherited from Upstream[Data]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from DataStore[Data] to any2stringadd[DataStore[Data]]

Inherited by implicit conversion StringFormat from DataStore[Data] to StringFormat[DataStore[Data]]

Inherited by implicit conversion Ensuring from DataStore[Data] to Ensuring[DataStore[Data]]

Inherited by implicit conversion ArrowAssoc from DataStore[Data] to ArrowAssoc[DataStore[Data]]

Ungrouped