c

bigglue.examples

FindAuthor

case class FindAuthor() extends Reducer[GitCommitInfo, GitCommitGroups] with Product with Serializable

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FindAuthor
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Reducer
  7. UnaryComputation
  8. UnaryChecker
  9. OutputStoreChecker
  10. InputStoreChecker
  11. ConfigChecker
  12. Computation
  13. ConfigBuildsPlatform
  14. ConfigBuilds
  15. AnyRef
  16. 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 FindAuthor()

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 FindAuthor to any2stringadd[FindAuthor] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def +->[End <: Identifiable[End]](p: Pipe[GitCommitGroups, End]): PartialReducerPipe[GitCommitInfo, GitCommitGroups, End]

    This is part of the series of calls that make the pipeline.

    This is part of the series of calls that make the pipeline. This is called within the FindAuthor()+->authorMap step. This links the reducer to the rest of the pipeline, which in this case is bigglue.pipes.Implicits.DataNode(authorMap).

    End

    The type of the final data store within the pipeline. Within the example, this would be bigglue.examples.GitCommitGroups.

    p

    The part of the pipeline that follows the reducer computation. In the example, this is simply authorMap.

    returns

    This returns a section of the pipe where the reducer is linked together with the pipe that starts with the output data store.

    Definition Classes
    Reducer
  5. def ->[B](y: B): (FindAuthor, B)
    Implicit
    This member is added by an implicit conversion from FindAuthor to ArrowAssoc[FindAuthor] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def check(conf: PipeConfig, inputMap: DataStore[GitCommitInfo], outputMap: DataStore[GitCommitGroups]): Unit

    Check routine for unary data processors

    Check routine for unary data processors

    conf

    the config file to check

    inputMap

    the input store to check

    outputMap

    the output store to check

    Definition Classes
    UnaryChecker
  9. 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
  10. def checkInput(inputMap: DataStore[GitCommitInfo]): Unit

    Check that input store is compatible with the host class.

    Check that input store is compatible with the host class. Default does nothing.

    inputMap

    the input store to check

    Definition Classes
    InputStoreChecker
  11. def checkOutput(outputMap: DataStore[GitCommitGroups]): Unit

    This allows us to type check the Reducer step; In order for it to work, the output needs to be a DataMap, so we need to make sure that it is before continuing.

    This allows us to type check the Reducer step; In order for it to work, the output needs to be a DataMap, so we need to make sure that it is before continuing.

    outputMap

    The Output Store to Check

    Definition Classes
    ReducerOutputStoreChecker
  12. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  13. val configOpt: Option[PipeConfig]
    Definition Classes
    ConfigBuilds
  14. var configOption: ConfOpt
    Definition Classes
    Computation
  15. def constructBuilder(config: PipeConfig = null): PlatformBuilder
    Definition Classes
    ConfigBuildsPlatformConfigBuilds
  16. def ensuring(cond: (FindAuthor) ⇒ Boolean, msg: ⇒ Any): FindAuthor
    Implicit
    This member is added by an implicit conversion from FindAuthor to Ensuring[FindAuthor] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: (FindAuthor) ⇒ Boolean): FindAuthor
    Implicit
    This member is added by an implicit conversion from FindAuthor to Ensuring[FindAuthor] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: Boolean, msg: ⇒ Any): FindAuthor
    Implicit
    This member is added by an implicit conversion from FindAuthor to Ensuring[FindAuthor] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. def ensuring(cond: Boolean): FindAuthor
    Implicit
    This member is added by an implicit conversion from FindAuthor to Ensuring[FindAuthor] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  20. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  22. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from FindAuthor to StringFormat[FindAuthor] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  23. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  24. def getConfig(config: PipeConfig): PipeConfig
    Definition Classes
    ConfigBuilds
  25. def getUnaryPlatform(): UnaryPlatform[GitCommitInfo, GitCommitGroups]
    Definition Classes
    UnaryComputation
  26. def init(conf: PipeConfig, inputMap: DataStore[GitCommitInfo], outputMap: DataStore[GitCommitGroups]): Unit

    This initializes the Reducer Computation.

    This initializes the Reducer Computation. It creates a UnaryPlatform with PlatformBuilder.reducerPlatform, then sets itself as the platform's computation, and then initializes the platform with UnaryPlatform.init.

    conf

    The configuration file to build from. Note: If there is a GitCommitInfo+->GitAuthors section in the bigglue section of the configuration file, it will overwrite part of the configuration file with the values within the step's section.

    inputMap

    The DataStore that data is being sent in from. In the example, this would be commitInfoMap, which is implemented with a bigglue.store.instances.solr.SolrDataMap.

    outputMap

    The DataStore that data is being sent to and updated from. In the example, this would be authorMap, which is implemented with a bigglue.store.instances.solr.SolrDataMap.

    Definition Classes
    Reducer
  27. def init(conf: PipeConfig, inputMap: DataStore[GitCommitInfo], outputMap: DataStore[GitCommitGroups], platform: UnaryPlatform[GitCommitInfo, GitCommitGroups]): Unit

    This connects the newly initialized platform to the Input Data Store by making it so the Input Data Store sends data down to the platform.

    This connects the newly initialized platform to the Input Data Store by making it so the Input Data Store sends data down to the platform.

    conf

    The configuration file.

    inputMap

    The Input Data Store

    outputMap

    The Output Data Store

    platform

    The Platform added by the Mapper or Reducer computations.

    Definition Classes
    UnaryComputation
  28. def init(config: PipeConfig, platform: Platform): Unit
    Definition Classes
    Computation
  29. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  30. def name(newName: String): UnaryComputation[GitCommitInfo, GitCommitGroups]
    Definition Classes
    UnaryComputation
  31. var name: String
    Definition Classes
    UnaryComputation
  32. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  33. final def notify(): Unit
    Definition Classes
    AnyRef
  34. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  35. def persist(): Unit

    If the computation has been initialized, it calls Platform.persist on the platform.

    If the computation has been initialized, it calls Platform.persist on the platform. This gives the platform the responsibility of what data to send/resend down the pipeline.

    Definition Classes
    Computation
  36. var platformOpt: Option[Platform]
    Definition Classes
    Computation
  37. def run(): Unit
    Definition Classes
    ReducerComputation
  38. def setConfig(pipeConfig: PipeConfig): Unit
    Definition Classes
    ConfigBuilds
  39. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  40. def terminate(): Unit
    Definition Classes
    Computation
  41. def toStep(conf: PipeConfig, step: String): PipeConfig
    Definition Classes
    Computation
  42. def tryFold(input: GitCommitInfo, output: GitCommitGroups): Option[GitCommitGroups]

    Attempts to call fold to get a new output for the Output Data Store If it fails, just returns None.

    Attempts to call fold to get a new output for the Output Data Store If it fails, just returns None.

    input

    The input document to update the output.

    output

    The output document that needs to be updated.

    returns

    A new output document based on input and output. Returns None if failed.

    Definition Classes
    Reducer
  43. def tryGroupBy(input: GitCommitInfo): Option[Identity[GitCommitGroups]]

    Attempts to call groupBy to get an Identity to get stuff to group by.

    Attempts to call groupBy to get an Identity to get stuff to group by. If that fails, then it just returns None.

    input

    The input document to find an output Identity for.

    returns

    The output identity to change; None if none.

    Definition Classes
    Reducer
  44. def tryZero(): Option[GitCommitGroups]

    Attempts to call zero to get a starting output set.

    Attempts to call zero to get a starting output set.

    returns

    The default output. In the case of the example, this would be Some(Counter(0)). Returns None if failed to get a default output.

    Definition Classes
    Reducer
  45. var unaryPlatformOpt: Option[UnaryPlatform[GitCommitInfo, GitCommitGroups]]
    Definition Classes
    UnaryComputation
  46. val versionOpt: Option[String]
    Definition Classes
    Computation
  47. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  48. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  49. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  50. def withConfig(newConfigOption: ConfOpt): Reducer[GitCommitInfo, GitCommitGroups]
    Definition Classes
    Reducer
  51. def [B](y: B): (FindAuthor, B)
    Implicit
    This member is added by an implicit conversion from FindAuthor to ArrowAssoc[FindAuthor] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from ConfigChecker

Inherited from Computation

Inherited from ConfigBuildsPlatform

Inherited from ConfigBuilds[PlatformBuilder]

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped