org.apache.ctakes.core.pipeline

Class PiperFileReader

java.lang.Object

org.apache.ctakes.core.pipeline.PiperFileReader

public final class PiperFileReader
extends Object

Creates a pipeline (PipelineBuilder) from specifications in a flat plaintext file.

There are several basic commands: package user_package_name load path_to_another_pipeline_file set ae_parameter_name=ae_parameter_value e_parameter_name=ae_parameter_value ... cli ae_parameter_name=cli_parameter_char e_parameter_name=cli_parameter_char ... reader collection_reader_class_name readFiles input_directory input_directory can be empty if ConfigParameterConstants.PARAM_INPUTDIR ("InputDirectory") was specified add ae_or_cc_class_name ae_parameter_name=ae_parameter_value e_parameter_name<=ae_parameter_value ... addLogged ae_or_cc_class_name ae_parameter_name=ae_parameter_value e_parameter_name=ae_parameter_value ... addDescription ae_or_cc_class_name addLast ae_or_cc_class_name collectCuis collectEntities writeXmis output_directory output_directory can be empty if XmiWriterCasConsumerCtakes.PARAM_OUTPUTDIR ("OutputDirectory") was specified // and # and ! may be used to mark line comments

class names must be fully-specified with package unless they are in standard ctakes cr ae or cc packages, or in a package specified by an earlier package command.

Since:

10/10/2016

Version:

%I%

Author:

SPF , chip-nlp

Constructor Summary

Constructors

Constructor and Description
PiperFileReader() Create and empty PipelineReader
PiperFileReader(String filePath) Create a PipelineReader and load a file with command parameter pairs for building a pipeline
PiperFileReader(String filePath, CliOptionals cliOptionals) Create a PipelineReader and load a file with command parameter pairs for building a pipeline

Method Summary

Modifier and Type	Method and Description
PipelineBuilder	getBuilder()
boolean	loadPipelineFile(String filePath) Load a file with command parameter pairs for building a pipeline
boolean	parsePipelineLine(String line)
void	setCliOptionals(CliOptionals cliOptionals)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PiperFileReader

public PiperFileReader()

Create and empty PipelineReader

PiperFileReader

public PiperFileReader(String filePath)
                throws org.apache.uima.UIMAException

Create a PipelineReader and load a file with command parameter pairs for building a pipeline

Parameters:

filePath - path to the pipeline command file

Throws:

org.apache.uima.UIMAException - if the pipeline cannot be loaded

PiperFileReader

public PiperFileReader(String filePath,
                       CliOptionals cliOptionals)
                throws org.apache.uima.UIMAException

Create a PipelineReader and load a file with command parameter pairs for building a pipeline

Parameters:

filePath - path to the pipeline command file

cliOptionals - command line options pre-defined

Throws:

org.apache.uima.UIMAException - if the pipeline cannot be loaded

Method Detail

setCliOptionals

public void setCliOptionals(CliOptionals cliOptionals)

loadPipelineFile

public boolean loadPipelineFile(String filePath)
                         throws org.apache.uima.UIMAException

Load a file with command parameter pairs for building a pipeline

Parameters:

filePath - path to the pipeline command file

Throws:

org.apache.uima.UIMAException

parsePipelineLine

public boolean parsePipelineLine(String line)
                          throws org.apache.uima.UIMAException

Throws:

org.apache.uima.UIMAException

getBuilder

public PipelineBuilder getBuilder()

Returns:

the PipelineBuilder with its current state set by this PipelineReader