Repository: opennlp-site Updated Branches: refs/heads/asf-site 7b428c4b4 -> 1c18a97ba
http://git-wip-us.apache.org/repos/asf/opennlp-site/blob/1c18a97b/docs/1.5.3/apidocs/opennlp-tools/opennlp/tools/cmdline/CmdLineUtil.html ---------------------------------------------------------------------- diff --git a/docs/1.5.3/apidocs/opennlp-tools/opennlp/tools/cmdline/CmdLineUtil.html b/docs/1.5.3/apidocs/opennlp-tools/opennlp/tools/cmdline/CmdLineUtil.html new file mode 100644 index 0000000..a023ffd --- /dev/null +++ b/docs/1.5.3/apidocs/opennlp-tools/opennlp/tools/cmdline/CmdLineUtil.html @@ -0,0 +1,488 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!--NewPage--> +<HTML> +<HEAD> +<!-- Generated by javadoc (build 1.5.0_22) on Wed Apr 03 10:03:15 GMT-03:00 2013 --> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<TITLE> +CmdLineUtil (Apache OpenNLP Tools 1.5.3 API) +</TITLE> + +<META NAME="keywords" CONTENT="opennlp.tools.cmdline.CmdLineUtil class"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="CmdLineUtil (Apache OpenNLP Tools 1.5.3 API)"; +} +</SCRIPT> +<NOSCRIPT> +</NOSCRIPT> + +</HEAD> + +<BODY BGCOLOR="white" onload="windowTitle();"> + + +<!-- ========= START OF TOP NAVBAR ======= --> +<A NAME="navbar_top"><!-- --></A> +<A HREF="#skip-navbar_top" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_top_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/CmdLineUtil.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../opennlp/tools/cmdline/CmdLineTool.html" title="class in opennlp.tools.cmdline"><B>PREV CLASS</B></A> + <A HREF="../../../opennlp/tools/cmdline/DetailedFMeasureListener.html" title="class in opennlp.tools.cmdline"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../index.html?opennlp/tools/cmdline/CmdLineUtil.html" target="_top"><B>FRAMES</B></A> + <A HREF="CmdLineUtil.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_top"></A> +<!-- ========= END OF TOP NAVBAR ========= --> + +<HR> +<!-- ======== START OF CLASS DATA ======== --> +<H2> +<FONT SIZE="-1"> +opennlp.tools.cmdline</FONT> +<BR> +Class CmdLineUtil</H2> +<PRE> +<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html"; title="class or interface in java.lang">java.lang.Object</A> + <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>opennlp.tools.cmdline.CmdLineUtil</B> +</PRE> +<HR> +<DL> +<DT><PRE>public final class <B>CmdLineUtil</B><DT>extends <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html"; title="class or interface in java.lang">Object</A></DL> +</PRE> + +<P> +Util class for the command line interface. + <p> + <b>Note:</b> Do not use this class, internal use only! +<P> + +<P> +<HR> + +<P> + +<!-- ========== METHOD SUMMARY =========== --> + +<A NAME="method_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Method Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../opennlp/tools/cmdline/CmdLineUtil.html#checkInputFile(java.lang.String, java.io.File)">checkInputFile</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A> name, + <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/File.html"; title="class or interface in java.io">File</A> inFile)</CODE> + +<BR> + Check that the given input file is valid.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../opennlp/tools/cmdline/CmdLineUtil.html#checkLanguageCode(java.lang.String)">checkLanguageCode</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A> code)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../opennlp/tools/cmdline/CmdLineUtil.html#checkOutputFile(java.lang.String, java.io.File)">checkOutputFile</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A> name, + <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/File.html"; title="class or interface in java.io">File</A> outFile)</CODE> + +<BR> + Tries to ensure that it is possible to write to an output file.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../opennlp/tools/cmdline/CmdLineUtil.html#containsParam(java.lang.String, java.lang.String[])">containsParam</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A> param, + <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A>[] args)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Double.html"; title="class or interface in java.lang">Double</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../opennlp/tools/cmdline/CmdLineUtil.html#getDoubleParameter(java.lang.String, java.lang.String[])">getDoubleParameter</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A> param, + <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A>[] args)</CODE> + +<BR> + Retrieves the specified parameter from the specified arguments.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Integer.html"; title="class or interface in java.lang">Integer</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../opennlp/tools/cmdline/CmdLineUtil.html#getIntParameter(java.lang.String, java.lang.String[])">getIntParameter</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A> param, + <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A>[] args)</CODE> + +<BR> + Retrieves the specified parameter from the specified arguments.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../opennlp/tools/cmdline/CmdLineUtil.html#getParameter(java.lang.String, java.lang.String[])">getParameter</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A> param, + <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A>[] args)</CODE> + +<BR> + Retrieves the specified parameter from the given arguments.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static int</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../opennlp/tools/cmdline/CmdLineUtil.html#getParameterIndex(java.lang.String, java.lang.String[])">getParameterIndex</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A> param, + <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A>[] args)</CODE> + +<BR> + Returns the index of the parameter in the arguments, or -1 if the parameter is not found.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../opennlp/tools/cmdline/CmdLineUtil.html#handleStdinIoError(java.io.IOException)">handleStdinIoError</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html"; title="class or interface in java.io">IOException</A> e)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static <A HREF="../../../opennlp/tools/util/TrainingParameters.html" title="class in opennlp.tools.util">TrainingParameters</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../opennlp/tools/cmdline/CmdLineUtil.html#loadTrainingParameters(java.lang.String, boolean)">loadTrainingParameters</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A> paramFile, + boolean supportSequenceTraining)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/FileInputStream.html"; title="class or interface in java.io">FileInputStream</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../opennlp/tools/cmdline/CmdLineUtil.html#openInFile(java.io.File)">openInFile</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/File.html"; title="class or interface in java.io">File</A> file)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../opennlp/tools/cmdline/CmdLineUtil.html#writeModel(java.lang.String, java.io.File, opennlp.tools.util.model.BaseModel)">writeModel</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A> modelName, + <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/File.html"; title="class or interface in java.io">File</A> modelFile, + <A HREF="../../../opennlp/tools/util/model/BaseModel.html" title="class in opennlp.tools.util.model">BaseModel</A> model)</CODE> + +<BR> + Writes a <A HREF="../../../opennlp/tools/util/model/BaseModel.html" title="class in opennlp.tools.util.model"><CODE>BaseModel</CODE></A> to disk.</TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html"; title="class or interface in java.lang">Object</A></B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> +</TR> +</TABLE> + +<P> + +<!-- ============ METHOD DETAIL ========== --> + +<A NAME="method_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Method Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="checkInputFile(java.lang.String, java.io.File)"><!-- --></A><H3> +checkInputFile</H3> +<PRE> +public static void <B>checkInputFile</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A> name, + <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/File.html"; title="class or interface in java.io">File</A> inFile)</PRE> +<DL> +<DD>Check that the given input file is valid. + <p> + To pass the test it must:<br> + - exist<br> + - not be a directory<br> + - accessibly<br> +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name which is used to refer to the file in an error message, it + should start with a capital letter.<DD><CODE>inFile</CODE> - the particular file to check to qualify an input file +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../opennlp/tools/cmdline/TerminateToolException.html" title="class in opennlp.tools.cmdline">TerminateToolException</A></CODE> - if test does not pass this exception is + thrown and an error message is printed to the console.</DL> +</DD> +</DL> +<HR> + +<A NAME="checkOutputFile(java.lang.String, java.io.File)"><!-- --></A><H3> +checkOutputFile</H3> +<PRE> +public static void <B>checkOutputFile</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A> name, + <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/File.html"; title="class or interface in java.io">File</A> outFile)</PRE> +<DL> +<DD>Tries to ensure that it is possible to write to an output file. + <p> + The method does nothing if it is possible to write otherwise + it prints an appropriate error message and a <A HREF="../../../opennlp/tools/cmdline/TerminateToolException.html" title="class in opennlp.tools.cmdline"><CODE>TerminateToolException</CODE></A> is thrown. + <p> + 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. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>name</CODE> - human-friendly file name. for example perceptron model<DD><CODE>outFile</CODE> - file</DL> +</DD> +</DL> +<HR> + +<A NAME="openInFile(java.io.File)"><!-- --></A><H3> +openInFile</H3> +<PRE> +public static <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/FileInputStream.html"; title="class or interface in java.io">FileInputStream</A> <B>openInFile</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/File.html"; title="class or interface in java.io">File</A> file)</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="writeModel(java.lang.String, java.io.File, opennlp.tools.util.model.BaseModel)"><!-- --></A><H3> +writeModel</H3> +<PRE> +public static void <B>writeModel</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A> modelName, + <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/File.html"; title="class or interface in java.io">File</A> modelFile, + <A HREF="../../../opennlp/tools/util/model/BaseModel.html" title="class in opennlp.tools.util.model">BaseModel</A> model)</PRE> +<DL> +<DD>Writes a <A HREF="../../../opennlp/tools/util/model/BaseModel.html" title="class in opennlp.tools.util.model"><CODE>BaseModel</CODE></A> to disk. Occurring errors are printed to the console + to inform the user. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>modelName</CODE> - type of the model, name is used in error messages.<DD><CODE>modelFile</CODE> - output file of the model<DD><CODE>model</CODE> - the model itself which should be written to disk</DL> +</DD> +</DL> +<HR> + +<A NAME="getParameterIndex(java.lang.String, java.lang.String[])"><!-- --></A><H3> +getParameterIndex</H3> +<PRE> +public static int <B>getParameterIndex</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A> param, + <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A>[] args)</PRE> +<DL> +<DD>Returns the index of the parameter in the arguments, or -1 if the parameter is not found. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>param</CODE> - parameter name<DD><CODE>args</CODE> - arguments +<DT><B>Returns:</B><DD>the index of the parameter in the arguments, or -1 if the parameter is not found</DL> +</DD> +</DL> +<HR> + +<A NAME="getParameter(java.lang.String, java.lang.String[])"><!-- --></A><H3> +getParameter</H3> +<PRE> +public static <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A> <B>getParameter</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A> param, + <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A>[] args)</PRE> +<DL> +<DD>Retrieves the specified parameter from the given arguments. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>param</CODE> - parameter name<DD><CODE>args</CODE> - arguments +<DT><B>Returns:</B><DD>parameter value</DL> +</DD> +</DL> +<HR> + +<A NAME="getIntParameter(java.lang.String, java.lang.String[])"><!-- --></A><H3> +getIntParameter</H3> +<PRE> +public static <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Integer.html"; title="class or interface in java.lang">Integer</A> <B>getIntParameter</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A> param, + <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A>[] args)</PRE> +<DL> +<DD>Retrieves the specified parameter from the specified arguments. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>param</CODE> - parameter name<DD><CODE>args</CODE> - arguments +<DT><B>Returns:</B><DD>parameter value</DL> +</DD> +</DL> +<HR> + +<A NAME="getDoubleParameter(java.lang.String, java.lang.String[])"><!-- --></A><H3> +getDoubleParameter</H3> +<PRE> +public static <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Double.html"; title="class or interface in java.lang">Double</A> <B>getDoubleParameter</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A> param, + <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A>[] args)</PRE> +<DL> +<DD>Retrieves the specified parameter from the specified arguments. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>param</CODE> - parameter name<DD><CODE>args</CODE> - arguments +<DT><B>Returns:</B><DD>parameter value</DL> +</DD> +</DL> +<HR> + +<A NAME="checkLanguageCode(java.lang.String)"><!-- --></A><H3> +checkLanguageCode</H3> +<PRE> +public static void <B>checkLanguageCode</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A> code)</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="containsParam(java.lang.String, java.lang.String[])"><!-- --></A><H3> +containsParam</H3> +<PRE> +public static boolean <B>containsParam</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A> param, + <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A>[] args)</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="handleStdinIoError(java.io.IOException)"><!-- --></A><H3> +handleStdinIoError</H3> +<PRE> +public static void <B>handleStdinIoError</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html"; title="class or interface in java.io">IOException</A> e)</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="loadTrainingParameters(java.lang.String, boolean)"><!-- --></A><H3> +loadTrainingParameters</H3> +<PRE> +public static <A HREF="../../../opennlp/tools/util/TrainingParameters.html" title="class in opennlp.tools.util">TrainingParameters</A> <B>loadTrainingParameters</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A> paramFile, + boolean supportSequenceTraining)</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<!-- ========= END OF CLASS DATA ========= --> +<HR> + + +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<A NAME="navbar_bottom"><!-- --></A> +<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_bottom_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/CmdLineUtil.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../opennlp/tools/cmdline/CmdLineTool.html" title="class in opennlp.tools.cmdline"><B>PREV CLASS</B></A> + <A HREF="../../../opennlp/tools/cmdline/DetailedFMeasureListener.html" title="class in opennlp.tools.cmdline"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../index.html?opennlp/tools/cmdline/CmdLineUtil.html" target="_top"><B>FRAMES</B></A> + <A HREF="CmdLineUtil.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_bottom"></A> +<!-- ======== END OF BOTTOM NAVBAR ======= --> + +<HR> +Copyright © 2013 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All Rights Reserved. +</BODY> +</HTML>
