Author: schor Date: Fri Jul 19 19:07:14 2019 New Revision: 1863418 URL: http://svn.apache.org/viewvc?rev=1863418&view=rev Log: no jira - more javadoc fixes
Modified: uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/utils/CPMUtils.java uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/utils/Execute.java uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/utils/ExpirationTimer.java uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/utils/QueueEntity.java uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/AnnotationViewerDialog.java uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/DocumentAnalyzer.java uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/PrefsMediator.java uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/stylemap/StyleMapEntry.java Modified: uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/utils/CPMUtils.java URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/utils/CPMUtils.java?rev=1863418&r1=1863417&r2=1863418&view=diff ============================================================================== --- uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/utils/CPMUtils.java (original) +++ uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/utils/CPMUtils.java Fri Jul 19 19:07:14 2019 @@ -63,8 +63,9 @@ public class CPMUtils { } /** + * Sets the timer. * - * @param aTimer + * @param aTimer the new timer */ public static void setTimer(UimaTimer aTimer) { timer = aTimer; @@ -79,10 +80,11 @@ public class CPMUtils { } /** + * Convert to absolute path. * - * @param aSystemVar - * @param aExpr - * @param aPathToConvert + * @param aSystemVar the a system var + * @param aExpr the a expr + * @param aPathToConvert the a path to convert * @return absolute path */ public static String convertToAbsolutePath(String aSystemVar, String aExpr, String aPathToConvert) { @@ -96,8 +98,8 @@ public class CPMUtils { * Return timer to measure performace of the cpm. The timer can optionally be configured in the * CPE descriptor. If none defined, the method returns default timer. * + * @param aTimerClass the a timer class * @return - customer timer or JavaTimer (default) - * * @throws Exception - */ public static UimaTimer getTimer(String aTimerClass) throws Exception { @@ -110,7 +112,7 @@ public class CPMUtils { } /** - * Returns the total duration of a given event + * Returns the total duration of a given event. * * @param aPT - * Event container @@ -168,6 +170,8 @@ public class CPMUtils { * Finds an occurance of the ##CPM_HOME in a value parameter and returns it with an expanded form * (ie.c:/cpm/...) based on the env variable CPM_HOME. * + * @param value the value + * @return the string */ public static String scrubThePath(String value) { if (value != null && value.indexOf(Constants.CPMPATH) > -1) { @@ -187,7 +191,7 @@ public class CPMUtils { * String - XPath path to a node * @return textual value of a node indicated in the XPath path * - * @exception Exception + * @exception Exception - */ private static String extractText(Node aNode) throws Exception { String text = null; @@ -206,7 +210,7 @@ public class CPMUtils { /** * - * @param entityNode + * @param entityNode the entity node * @return a configurable feature * @throws ConfigurationException - */ @@ -260,8 +264,9 @@ public class CPMUtils { } /** + * Gets the features. * - * @param attributesNode + * @param attributesNode the attributes node * @return a list of features * @throws ConfigurationException - */ @@ -303,8 +308,9 @@ public class CPMUtils { } /** + * Find deploy directory. * - * @param aServiceName + * @param aServiceName the a service name * @return the deploy directory * @throws Exception - */ @@ -387,6 +393,7 @@ public class CPMUtils { * @param aName - * name of the feature * @return - value as String + * @throws Exception the exception */ public static String getFeatureAsString(CAS aCas, Feature aFeature, String aName) throws Exception { Modified: uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/utils/Execute.java URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/utils/Execute.java?rev=1863418&r1=1863417&r2=1863418&view=diff ============================================================================== --- uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/utils/Execute.java (original) +++ uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/utils/Execute.java Fri Jul 19 19:07:14 2019 @@ -65,7 +65,7 @@ public class Execute { /** * Copies Cas Processor environment * - * @param strings + * @param strings the new environment */ public void setEnvironment(String[] strings) { environment = strings; Modified: uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/utils/ExpirationTimer.java URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/utils/ExpirationTimer.java?rev=1863418&r1=1863417&r2=1863418&view=diff ============================================================================== --- uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/utils/ExpirationTimer.java (original) +++ uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/utils/ExpirationTimer.java Fri Jul 19 19:07:14 2019 @@ -41,6 +41,11 @@ public class ExpirationTimer extends Thr /** * Constructs a Timer that expires after a given interval. It keeps the map from growing * indefinitely. Its main purpose is to remove entries from a given map using a provided key. + * + * @param aTimeout the a timeout + * @param aMap the a map + * @param aKey the a key + * @param aCpm the a cpm */ public ExpirationTimer(long aTimeout, HashMap aMap, String aKey, CPMEngine aCpm) { super(); Modified: uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/utils/QueueEntity.java URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/utils/QueueEntity.java?rev=1863418&r1=1863417&r2=1863418&view=diff ============================================================================== --- uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/utils/QueueEntity.java (original) +++ uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/utils/QueueEntity.java Fri Jul 19 19:07:14 2019 @@ -33,7 +33,10 @@ public class QueueEntity { private Object entity = null; /** - * Initialize the instance with the Entity (CAS) and the timeout + * Initialize the instance with the Entity (CAS) and the timeout. + * + * @param anEntity the an entity + * @param hasTimedOut the has timed out */ public QueueEntity(Object anEntity, boolean hasTimedOut) { timedOut = hasTimedOut; Modified: uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/AnnotationViewerDialog.java URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/AnnotationViewerDialog.java?rev=1863418&r1=1863417&r2=1863418&view=diff ============================================================================== --- uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/AnnotationViewerDialog.java (original) +++ uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/AnnotationViewerDialog.java Fri Jul 19 19:07:14 2019 @@ -139,28 +139,21 @@ public class AnnotationViewerDialog exte private String defaultCasViewName = CAS.NAME_DEFAULT_SOFA; /** - * Create an AnnotationViewer Dialog - * - * @param aParentFrame - * frame containing this panel - * @param aDialogTitle - * title to display for the dialog - * @param med + * Create an AnnotationViewer Dialog. * - * @param aStyleMapFile - * filename of style map to be used to view files in HTML - * @param aPerformanceStats - * string representaiton of performance statistics, optional. - * @param aTypeSystem - * the CAS Type System to which the XCAS files must conform. - * @param aTypesToDisplay - * array of types that should be highlighted in the viewer. This can be set to the output + * @param aParentFrame frame containing this panel + * @param aDialogTitle title to display for the dialog + * @param med the med + * @param aStyleMapFile filename of style map to be used to view files in HTML + * @param aPerformanceStats string representaiton of performance statistics, optional. + * @param aTypeSystem the CAS Type System to which the XCAS files must conform. + * @param aTypesToDisplay array of types that should be highlighted in the viewer. This can be set to the output * types of the Analysis Engine. A value of null means to display all types. - * @param interactiveTempFN - * @param javaViewerRBisSelected - * @param javaViewerUCRBisSelected - * @param xmlRBisSelected - * @param cas + * @param interactiveTempFN the interactive temp FN + * @param javaViewerRBisSelected the java viewer R bis selected + * @param javaViewerUCRBisSelected the java viewer UCR bis selected + * @param xmlRBisSelected the xml R bis selected + * @param cas the cas */ public AnnotationViewerDialog(JFrame aParentFrame, String aDialogTitle, PrefsMediator med, File aStyleMapFile, String aPerformanceStats, TypeSystem aTypeSystem, @@ -417,6 +410,8 @@ public class AnnotationViewerDialog exte /** * Gets the name of the CAS View that will be displayed first in * the annotation viewer. + * + * @return the default cas view name */ public String getDefaultCasViewName() { return defaultCasViewName; @@ -425,6 +420,8 @@ public class AnnotationViewerDialog exte /** * Sets the name of the CAS View that will be displayed first in * the annotation viewer. It not set, defaults to {@link CAS#NAME_DEFAULT_SOFA}. + * + * @param defaultCasViewName the new default cas view name */ public void setDefaultCasViewName(String defaultCasViewName) { this.defaultCasViewName = defaultCasViewName; @@ -529,6 +526,9 @@ public class AnnotationViewerDialog exte /** * Assumes node has a text field and extracts its value. JMP + * + * @param node the node + * @return the text value */ static public String getTextValue(Node node) { Node first = node.getFirstChild(); @@ -541,6 +541,10 @@ public class AnnotationViewerDialog exte /** * Gets the first child with a given name. JMP + * + * @param node the node + * @param name the name + * @return the first child by name */ static public Node getFirstChildByName(Node node, String name) { NodeList children = node.getChildNodes(); @@ -555,6 +559,9 @@ public class AnnotationViewerDialog exte /** * Reads in annotation-color associations from stylemap file. JMP Also reads checked value if * present. + * + * @param viewer the viewer + * @param aStyleMapFile the a style map file */ public void getColorsForTypesFromFile(CasAnnotationViewer viewer, File aStyleMapFile) { @@ -709,6 +716,9 @@ public class AnnotationViewerDialog exte * AnalysisEngineDescription object. * * @return the selected AnalysisEngineDescription, null if the user cancelled + * @throws IOException Signals that an I/O exception has occurred. + * @throws InvalidXMLException the invalid XML exception + * @throws ResourceInitializationException the resource initialization exception */ protected AnalysisEngineDescription promptForAE() throws IOException, InvalidXMLException, ResourceInitializationException { Modified: uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/DocumentAnalyzer.java URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/DocumentAnalyzer.java?rev=1863418&r1=1863417&r2=1863418&view=diff ============================================================================== --- uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/DocumentAnalyzer.java (original) +++ uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/DocumentAnalyzer.java Fri Jul 19 19:07:14 2019 @@ -556,6 +556,8 @@ public class DocumentAnalyzer extends JF * documents and generates the output. Displays a progress bar while processing is occuring. When * processing is complete, allows the user to view the results. JMP added arg for input text to * analyze. + * + * @param analysisText the analysis text */ public void analyzeDocuments(String analysisText) { // get field values from GUI @@ -691,6 +693,10 @@ public class DocumentAnalyzer extends JF } /** + * Entity process complete. + * + * @param aCas the a cas + * @param aStatus the a status * @see org.apache.uima.collection.StatusCallbackListener#entityProcessComplete(org.apache.uima.cas.CAS, * org.apache.uima.collection.EntityProcessStatus) */ @@ -970,6 +976,8 @@ public class DocumentAnalyzer extends JF /** * Runs the application. + * + * @param args the arguments */ public static void main(String[] args) { final DocumentAnalyzer frame = new DocumentAnalyzer(); @@ -989,7 +997,10 @@ public class DocumentAnalyzer extends JF private JTextPane textPane = new JTextPane(); /** - * Constructor for dialog + * Constructor for dialog. + * + * @param aiDialog the ai dialog + * @param generatedStyleMap the generated style map */ public TextAreaViewer(final JDialog aiDialog, boolean generatedStyleMap) { Modified: uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/PrefsMediator.java URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/PrefsMediator.java?rev=1863418&r1=1863417&r2=1863418&view=diff ============================================================================== --- uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/PrefsMediator.java (original) +++ uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/PrefsMediator.java Fri Jul 19 19:07:14 2019 @@ -172,6 +172,7 @@ public class PrefsMediator { /** * get the path to the TAE that is where the StyleMap file should be written * + * @return the TAE path */ public String getTAEPath() { int index = indexOfLastFileSeparator(taeDir); @@ -201,7 +202,8 @@ public class PrefsMediator { /** * Gets index of last file separator character in a file path. * Supports File.separator but also / on Windows. - * @param path + * + * @param path the path * @return index of the last file separator char. Returns -1 if none. */ private int indexOfLastFileSeparator(String path) { @@ -317,7 +319,11 @@ public class PrefsMediator { prefs.putBoolean(LENIENT, lenient); } - /** returns the new edited stylemap file */ + /** + * returns the new edited stylemap file. + * + * @return the stylemap file + */ public File getStylemapFile() { String s = getTAEPath() + getTAEFileNameRoot() + "StyleMap.xml"; return new File(s); Modified: uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/stylemap/StyleMapEntry.java URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/stylemap/StyleMapEntry.java?rev=1863418&r1=1863417&r2=1863418&view=diff ============================================================================== --- uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/stylemap/StyleMapEntry.java (original) +++ uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/stylemap/StyleMapEntry.java Fri Jul 19 19:07:14 2019 @@ -81,6 +81,8 @@ public class StyleMapEntry { * This method returns a pattern representing either simply an annotation type or else an * annotation type/feature value. In the case of the latter: e.g. * SYNTAX_ANNOT_TYPE[@SYNTAXLABEL_STRING='NP'] + * + * @return the pattern */ public String getPattern() { @@ -102,8 +104,9 @@ public class StyleMapEntry { } /** - * @param background - * The background to set. + * Sets the background. + * + * @param background The background to set. */ public void setBackground(Color background) { this.background = background;