com.sun.labs.minion.pipeline
Class PipelineFactory

java.lang.Object
  extended by com.sun.labs.minion.pipeline.PipelineFactory
All Implemented Interfaces:
com.sun.labs.util.props.Component, com.sun.labs.util.props.Configurable

public class PipelineFactory
extends java.lang.Object
implements com.sun.labs.util.props.Configurable

A configurable factor class for pipelines. This factor class can be used to get synchronous or asynchronous pipeline stages.


Field Summary
protected static java.lang.String logTag
           
static java.lang.String PROP_DUMPER
           
static java.lang.String PROP_HL_STAGES
           
static java.lang.String PROP_STAGES
           
 
Constructor Summary
PipelineFactory()
          Creates a pipeline factory.
 
Method Summary
 Pipeline getAsynchronousPipeline(SearchEngine engine, java.util.concurrent.BlockingQueue<Indexable> indexingQueue)
          Gets an asynchronous pipeline configured according to the configuration of the indexer.
 HLPipeline getHLPipeline(SearchEngine engine)
          Gets a highlighting pipeline configured according to the configuration.
 Stage getIndexingStage()
          Gets a new indexing stage, so that such stages can be handed off to someone else for dumping while indexing proceeds.
 java.lang.String getName()
           
 Pipeline getSynchronousPipeline(SearchEngine engine)
          Gets a synchronous pipeline configured according to the configuration of the indexer.
 void newProperties(com.sun.labs.util.props.PropertySheet ps)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

logTag

protected static java.lang.String logTag

PROP_STAGES

@ConfigComponentList(type=Stage.class)
public static final java.lang.String PROP_STAGES
See Also:
Constant Field Values

PROP_HL_STAGES

@ConfigComponentList(type=Stage.class)
public static final java.lang.String PROP_HL_STAGES
See Also:
Constant Field Values

PROP_DUMPER

@ConfigComponent(type=Dumper.class)
public static final java.lang.String PROP_DUMPER
See Also:
Constant Field Values
Constructor Detail

PipelineFactory

public PipelineFactory()
Creates a pipeline factory. This class should be configured using the configuration manager for the indexer.

Method Detail

getSynchronousPipeline

public Pipeline getSynchronousPipeline(SearchEngine engine)
Gets a synchronous pipeline configured according to the configuration of the indexer.


getAsynchronousPipeline

public Pipeline getAsynchronousPipeline(SearchEngine engine,
                                        java.util.concurrent.BlockingQueue<Indexable> indexingQueue)
Gets an asynchronous pipeline configured according to the configuration of the indexer.

Parameters:
indexingQueue - a queue from which the pipeline will draw the documents that it will process

getHLPipeline

public HLPipeline getHLPipeline(SearchEngine engine)
Gets a highlighting pipeline configured according to the configuration.


getIndexingStage

public Stage getIndexingStage()
Gets a new indexing stage, so that such stages can be handed off to someone else for dumping while indexing proceeds.


newProperties

public void newProperties(com.sun.labs.util.props.PropertySheet ps)
                   throws com.sun.labs.util.props.PropertyException
Specified by:
newProperties in interface com.sun.labs.util.props.Configurable
Throws:
com.sun.labs.util.props.PropertyException

getName

public java.lang.String getName()