t

bigglue.checkers

ConfigChecker

trait ConfigChecker extends AnyRef

Created by edmundlam on 8/18/17.

This module contains traits which implement basic checking routines targeted at config files and input and output store types. These checking routines are expected to be ran before initialization of the sub-components of the pipes, to weed out malformed configs and store type incompatibility (between input/output DataStores and Computations/Platforms). The generic checks essentially imposes no constraints, hence does nothing. Override the appropriate checking routines to implement specific constraints on config, input and output data stores.

A note on 'type compatibility' check: the design choice of making this a 'dynamic' check was not taken lightly. While I love to attempt to make this statically typed (e.g., by annotating Computation class with DataStore types) but it would introduce too many type parameter clutter to the Computation/Platform classes. I thought that this (below) would be a fair compromise.

Linear Supertypes
AnyRef, Any
Known Subclasses
BinaryChecker, UnaryChecker, BinaryComputation, CartesianProduct, Mapper, PairwiseComposer, Reducer, UnaryComputation, Clone, CommitExtraction, FindAuthor, BinaryPlatform, UnaryPlatform, MapperPlatform, BigActorBinaryPlatform, BigActorMapperPlatform, BigActorPairwiseComposerPlatform, BigActorReducerPlatform, BigActorUnaryPlatform, KafkaStreamMapperPlatform, KafkaStreamPlatform, ThinActorBinaryPlatform, ThinActorMapperPlatform, ThinActorPairwiseComposerPlatform, ThinActorReducerPlatform, ThinActorUnaryPlatform, DataMap, DataMultiMap, DataQueue, DataStore, IdDataMap, TupleDataMap, TupleDataStore, BothDataStore, InMemDataMap, InMemDataMultiMap, InMemDataQueue, InMemIdDataMap, InMemLinearStore, FileSystemDataMap, FileSystemIdDataMap, TextFileDataMap, KafkaDataMap, KafkaQueue, SolrDataMap, SolrMultiMap
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ConfigChecker
  2. AnyRef
  3. 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

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 ConfigChecker to any2stringadd[ConfigChecker] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ConfigChecker, B)
    Implicit
    This member is added by an implicit conversion from ConfigChecker to ArrowAssoc[ConfigChecker] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. 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

  8. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. def ensuring(cond: (ConfigChecker) ⇒ Boolean, msg: ⇒ Any): ConfigChecker
    Implicit
    This member is added by an implicit conversion from ConfigChecker to Ensuring[ConfigChecker] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (ConfigChecker) ⇒ Boolean): ConfigChecker
    Implicit
    This member is added by an implicit conversion from ConfigChecker to Ensuring[ConfigChecker] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: ⇒ Any): ConfigChecker
    Implicit
    This member is added by an implicit conversion from ConfigChecker to Ensuring[ConfigChecker] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): ConfigChecker
    Implicit
    This member is added by an implicit conversion from ConfigChecker to Ensuring[ConfigChecker] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  15. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ConfigChecker to StringFormat[ConfigChecker] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  17. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  23. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. def →[B](y: B): (ConfigChecker, B)
    Implicit
    This member is added by an implicit conversion from ConfigChecker to ArrowAssoc[ConfigChecker] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ConfigChecker to any2stringadd[ConfigChecker]

Inherited by implicit conversion StringFormat from ConfigChecker to StringFormat[ConfigChecker]

Inherited by implicit conversion Ensuring from ConfigChecker to Ensuring[ConfigChecker]

Inherited by implicit conversion ArrowAssoc from ConfigChecker to ArrowAssoc[ConfigChecker]

Ungrouped