Class CmdLineUtil

java.lang.Object
opennlp.tools.cmdline.CmdLineUtil

@Internal public final class CmdLineUtil extends Object
Util class for the command line interface.

Note: Do not use this class, internal use only!

  • Field Details

    • logger

      private static final org.slf4j.Logger logger
    • IO_BUFFER_SIZE

      static final int IO_BUFFER_SIZE
      See Also:
  • Constructor Details

    • CmdLineUtil

      private CmdLineUtil()
  • Method Details

    • checkInputFile

      public static void checkInputFile(String name, File inFile)
      Check that the given input file is valid.

      To pass the test it must:
      - exist
      - not be a directory,
      - and be accessibly.

      Parameters:
      name - the name which is used to refer to the file in an error message, it should start with a capital letter.
      inFile - the particular File to check to qualify an input file
      Throws:
      TerminateToolException - if test does not pass this exception is thrown and an error message is printed to the console.
    • checkOutputFile

      public static void checkOutputFile(String name, File outFile)
      Tries to ensure that it is possible to write to an output file.

      The method does nothing if it is possible to write otherwise it prints an appropriate error message and a TerminateToolException is thrown.

      Computing the contents of an output file (e.g. ME model) can be very time-consuming. Prior to this computation it should be checked once that writing this output file is possible to be able to fail fast if not. If this validation is only done after a time-consuming computation it could frustrate the user.

      Parameters:
      name - human-friendly file name. for example perceptron model
      outFile - the particular File to check to qualify an output file
    • openInFile

      public static FileInputStream openInFile(File file)
    • createInputStreamFactory

      public static InputStreamFactory createInputStreamFactory(File file)
    • writeModel

      public static void writeModel(String modelName, File modelFile, BaseModel model)
      Writes a BaseModel to disk. Occurring errors are printed to the console to inform the user.
      Parameters:
      modelName - name of the model, name is used in error messages.
      modelFile - output file of the model
      model - the model itself which should be written to disk
    • getParameterIndex

      public static int getParameterIndex(String param, String[] args)
      Returns the index of the parameter in the arguments, or -1 if the parameter is not found.
      Parameters:
      param - parameter name
      args - arguments
      Returns:
      the index of the parameter in the arguments, or -1 if the parameter is not found
    • getParameter

      public static String getParameter(String param, String[] args)
      Retrieves the specified parameter from the given arguments.
      Parameters:
      param - parameter name
      args - arguments
      Returns:
      parameter value
    • getIntParameter

      public static Integer getIntParameter(String param, String[] args)
      Retrieves the specified parameter from the specified arguments.
      Parameters:
      param - parameter name
      args - arguments
      Returns:
      parameter value
    • getDoubleParameter

      public static Double getDoubleParameter(String param, String[] args)
      Retrieves the specified parameter from the specified arguments.
      Parameters:
      param - parameter name
      args - arguments
      Returns:
      parameter value
    • checkLanguageCode

      public static void checkLanguageCode(String code)
    • containsParam

      public static boolean containsParam(String param, String[] args)
    • handleStdinIoError

      public static void handleStdinIoError(IOException e)
    • createObjectStreamError

      public static TerminateToolException createObjectStreamError(IOException e)
    • handleCreateObjectStreamError

      public static void handleCreateObjectStreamError(IOException e)
    • loadTrainingParameters

      public static TrainingParameters loadTrainingParameters(String paramFile, boolean supportSequenceTraining)