Pipeline

Value Members

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

   

   Definition Classes

   AnyRef → Any

2. final def ##(): Int

   

   Definition Classes

   AnyRef → Any

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

   

   Definition Classes

   AnyRef → Any

4. var _benchmark: Option[Boolean]

   

   Attributes

   protected

   Definition Classes

   HasBenchmark

5. def addStage(stage: Stage): Pipeline.this.type

   

   Add a new stage to the pipeline

   Add a new stage to the pipeline

   stage

   stage object

6. def addStage[T <: Factory[_]](constructorArgs: Array[AnyRef] = Array.empty, persistence: Boolean = true)(implicit arg0: ClassTag[T]): Pipeline.this.type

   

   Add a new stage containing the given factory

   Add a new stage containing the given factory

   T

   Class of the Factory

   constructorArgs

   Arguments of the primary constructor of the factory

   persistence

   if set to true, then the write method of the factory will be called to persist the output.

   Annotations

   @throws( ... )

   Exceptions thrown

   IllegalArgumentException this will be thrown if arguments don't match

7. def addStage(factory: Class[_ <: Factory[_]], constructorArgs: AnyRef*): Pipeline.this.type

   

   Add a new stage containing the given factory

   Add a new stage containing the given factory

   factory

   Factory to be executed

   constructorArgs

   Arguments of the primary constructor of the factory

   Annotations

   @throws( ... )

   Exceptions thrown

   IllegalArgumentException this will be thrown if arguments don't match

8. def addStage(factory: Factory[_]): Pipeline.this.type

   

   Add a new stage containing the given factory

   Add a new stage containing the given factory

   factory

   Factory to be executed

9. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

10. def benchmark(boo: Boolean): Pipeline.this.type

    

    Set to true to enable the benchmarking

    Set to true to enable the benchmarking

    boo

    true to enable benchmarking

    returns

    this object

    Definition Classes

    HasBenchmark

11. def benchmark: Option[Boolean]

    

    True if the benchmark will be measured, otherwise false

    True if the benchmark will be measured, otherwise false

    returns

    boolean

    Definition Classes

    HasBenchmark

12. def clearRegistry(): Unit

    

    Clear the registry

    Clear the registry

    Attributes

    protected

    Definition Classes

    HasRegistry

13. def clone(): AnyRef

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

14. def deliverableDispatcher: DeliverableDispatcher

    

    Get the deliverable dispatcher of this pipeline

15. def describe(): Pipeline.this.type

    

    Describe the pipeline

    Describe the pipeline

    Definition Classes

    Pipeline → HasDescription

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

    

    Definition Classes

    AnyRef

17. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

18. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

19. def getBenchmarkResult: Array[BenchmarkResult]

    

    Get the aggregated benchmark result.

    Get the aggregated benchmark result.

    returns

    an array of BenchmarkResult

    Definition Classes

    Pipeline → HasBenchmark

20. def getCanonicalName: String

    

    Definition Classes

    Identifiable

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

    

    Definition Classes

    AnyRef → Any

22. def getDeliverable(t: scala.reflect.api.JavaUniverse.Type): Array[Deliverable[_]]

    

    Get the Deliverable of the given runtime Type

    Get the Deliverable of the given runtime Type

    t

    runtime type of the Deliverable's payload

23. def getLastOutput: Any

    

    Get the output of the last factory of the last stage

    Get the output of the last factory of the last stage

    returns

    an object. it has to be convert to the according type manually.

24. def getOutput[A](cls: Class[_ <: Factory[_]]): A

    

    Get the output of a specific Factory

    Get the output of a specific Factory

    cls

    class of the Factory

25. def getPrettyName: String

    

    Definition Classes

    HasDescription

26. def getPrettyName(tpe: scala.reflect.api.JavaUniverse.Type): String

    

    Definition Classes

    HasDescription

27. def getPrettyName(canonicalName: String): String

    

    Definition Classes

    HasDescription

28. def getPrettyName(cls: Class[_]): String

    

    Definition Classes

    HasDescription

29. def getRegisteredItem(uuid: UUID): Option[Stage]

    

    For a given UUID, return the corresponding registered item

    For a given UUID, return the corresponding registered item

    uuid

    uuid

    Definition Classes

    HasRegistry

30. def getRegistry: ListMap[UUID, Stage]

    

    Return the registry

    Return the registry

    Definition Classes

    HasRegistry

31. def getRegistryLength: Long

    

    Return the number of items in the current registry

    Return the number of items in the current registry

    Definition Classes

    HasRegistry

32. def getStage(id: Int): Option[Stage]

    

33. def getUUID: UUID

    

    Definition Classes

    Identifiable

34. def hasRegisteredItem(uuid: UUID): Boolean

    

    Check if the UUID exists in the registry

    Check if the UUID exists in the registry

    uuid

    an UUID

    returns

    true if it already exists in the registry, false otherwise

    Definition Classes

    HasRegistry

35. def hasRegisteredItem(item: Identifiable): Boolean

    

    Check if the Identifiable exists in the registry

    Check if the Identifiable exists in the registry

    item

    an object that inherit com.jcdecaux.setl.internal.Identifiable

    returns

    true if it already exists in the registry, false otherwise

    Definition Classes

    HasRegistry

36. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

37. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

38. def isRegistryEmpty: Boolean

    

    Return true if the registry is empty, false otherwise

    Return true if the registry is empty, false otherwise

    Definition Classes

    HasRegistry

39. def lastRegisteredItem: Option[Stage]

    

    Return the last registered item

    Return the last registered item

    returns

    if the registry is empty, None will be returned

    Definition Classes

    HasRegistry

40. def log: Logger

    

    Attributes

    protected

    Definition Classes

    Logging

41. def logName: String

    

    Attributes

    protected

    Definition Classes

    Logging

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

    

    Definition Classes

    AnyRef

43. final def notify(): Unit

    

    Definition Classes

    AnyRef

44. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

45. def optimization(boolean: Boolean): Pipeline.this.type

    

    Set to true to allow auto optimization of this pipeline.

    Set to true to allow auto optimization of this pipeline. The default SimplePipelineOptimizer will be used.

    boolean

    true to allow optimization, otherwise false

    returns

    this pipeline

46. def optimization(optimizer: PipelineOptimizer): Pipeline.this.type

    

    Optimise execution with an optimizer

    Optimise execution with an optimizer

    optimizer

    an implementation of pipeline optimizer

    returns

    this pipeline

47. def optimization: Boolean

    

    Boolean indicating if the pipeline will be optimized

48. def pipelineInspector: PipelineInspector

    

    Get the inspector of this pipeline

49. def registerNewItem(item: Stage): Unit

    

    Register a new com.jcdecaux.setl.internal.Identifiable in registry

    Register a new com.jcdecaux.setl.internal.Identifiable in registry

    item

    an object that inherit com.jcdecaux.setl.internal.Identifiable

    returns

    true if the given item is registered, false otherwise

    Attributes

    protected

    Definition Classes

    HasRegistry

    Annotations

    @throws( ... )

50. def registerNewItems(items: Iterable[Stage]): Unit

    

    Register multiple items

    Register multiple items

    items

    an com.jcdecaux.setl.internal.Identifiable object

    Attributes

    protected

    Definition Classes

    HasRegistry

51. def run(): Pipeline.this.type

    

    Execute the pipeline

52. def setInput[T](payload: T, deliveryId: String)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T]): Pipeline.this.type

    

    Set input of the pipeline

    Set input of the pipeline

    T

    type of payload

    payload

    object to be delivered

    deliveryId

    id of this delivery

53. def setInput[T](payload: T)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T]): Pipeline.this.type

    

    Set input of the pipeline

    Set input of the pipeline

    T

    type of payload

    payload

    object to be delivered

54. def setInput[T](payload: T, consumer: Class[_ <: Factory[_]], deliveryId: String)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T]): Pipeline.this.type

    

    Set input of the pipeline

    Set input of the pipeline

    T

    type of payload

    payload

    object to be delivered

    consumer

    consumer of this payload

    deliveryId

    id of this delivery

55. def setInput[T](payload: T, consumer: Class[_ <: Factory[_]])(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T]): Pipeline.this.type

    

    Set input of the pipeline

    Set input of the pipeline

    T

    type of payload

    payload

    object to be delivered

    consumer

    consumer of this payload

56. def setInput[T](payload: T, consumer: Class[_ <: Factory[_]], consumers: Class[_ <: Factory[_]]*)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T]): Pipeline.this.type

    

    Set input of the pipeline

    Set input of the pipeline

    T

    type of payload

    payload

    object to be delivered

    consumer

    consumer of this payload

    consumers

    other consumers of the payload

57. def setInput[T](payload: T, deliveryId: String, consumer: Class[_ <: Factory[_]], consumers: Class[_ <: Factory[_]]*)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T]): Pipeline.this.type

    

    Set input of the pipeline

    Set input of the pipeline

    T

    type of payload

    payload

    object to be delivered

    deliveryId

    id of this delivery

    consumer

    consumer of this payload

    consumers

    other consumers of the payload

58. def setInput[T](payload: T, consumer: Seq[Class[_ <: Factory[_]]], deliveryId: String)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T]): Pipeline.this.type

    

    Set input of the pipeline

    Set input of the pipeline

    T

    type of payload

    payload

    object to be delivered

    consumer

    consumer of this payload

    deliveryId

    id of this delivery

59. def setInput(deliverable: Deliverable[_]): Pipeline.this.type

    

    Put the Deliverable to the input pool of the pipeline

    Put the Deliverable to the input pool of the pipeline

    deliverable

    Deliverable object

60. def stages: List[Stage]

    

    Return all the stages of this pipeline

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

    

    Definition Classes

    AnyRef

62. def toString(): String

    

    Definition Classes

    AnyRef → Any

63. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )