opennlp.tools.cmdline
Class AbstractTypedParamTool<T,P>

java.lang.Object
  extended by opennlp.tools.cmdline.CmdLineTool
      extended by opennlp.tools.cmdline.TypedCmdLineTool<T>
          extended by opennlp.tools.cmdline.AbstractTypedParamTool<T,P>
Direct Known Subclasses:
AbstractEvaluatorTool, AbstractTrainerTool, BuildModelUpdaterTool, CheckModelUpdaterTool

public abstract class AbstractTypedParamTool<T,P>
extends TypedCmdLineTool<T>

Base class for tools which take additional parameters. For example, trainers or evaluators.


Field Summary
protected  Class<P> paramsClass
          variable to access the parameters
 
Fields inherited from class opennlp.tools.cmdline.TypedCmdLineTool
type
 
Constructor Summary
protected AbstractTypedParamTool(Class<T> sampleType, Class<P> paramsClass)
          Constructor with type parameters.
 
Method Summary
 String getHelp(String format)
          Retrieves a description on how to use the tool.
 
Methods inherited from class opennlp.tools.cmdline.TypedCmdLineTool
getBasicHelp, getHelp, getStreamFactory, run, validateAllArgs, validateFactoryArgs
 
Methods inherited from class opennlp.tools.cmdline.CmdLineTool
getBasicHelp, getName, getShortDescription, hasParams, validateAndParseParams
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

paramsClass

protected final Class<P> paramsClass
variable to access the parameters

Constructor Detail

AbstractTypedParamTool

protected AbstractTypedParamTool(Class<T> sampleType,
                                 Class<P> paramsClass)
Constructor with type parameters.

Parameters:
sampleType - class of the template parameter
paramsClass - interface with parameters
Method Detail

getHelp

public String getHelp(String format)
Description copied from class: TypedCmdLineTool
Retrieves a description on how to use the tool.

Specified by:
getHelp in class TypedCmdLineTool<T>
Parameters:
format - data format
Returns:
a description on how to use the tool


Copyright © 2013 The Apache Software Foundation. All Rights Reserved.