You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by sc...@apache.org on 2013/09/09 21:41:17 UTC
svn commit: r1521265 - in
/uima/uimaj/trunk/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci:
./ util/
Author: schor
Date: Mon Sep 9 19:41:16 2013
New Revision: 1521265
URL: http://svn.apache.org/r1521265
Log:
[UIMA-3256] fixup Javadocs
Modified:
uima/uimaj/trunk/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciAnalysisEngineServiceStub.java
uima/uimaj/trunk/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciAnalysisEngineService_impl.java
uima/uimaj/trunk/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciBinaryAnalysisEngineServiceStub.java
uima/uimaj/trunk/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciBinaryAnalysisEngineService_impl.java
uima/uimaj/trunk/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/util/Descriptor.java
uima/uimaj/trunk/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/util/UimaSaxVinciFrameBuilder.java
Modified: uima/uimaj/trunk/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciAnalysisEngineServiceStub.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciAnalysisEngineServiceStub.java?rev=1521265&r1=1521264&r2=1521265&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciAnalysisEngineServiceStub.java (original)
+++ uima/uimaj/trunk/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciAnalysisEngineServiceStub.java Mon Sep 9 19:41:16 2013
@@ -31,13 +31,14 @@ import org.apache.uima.adapter.vinci.uti
import org.apache.uima.analysis_engine.AnalysisEngine;
import org.apache.uima.analysis_engine.AnalysisEngineServiceStub;
import org.apache.uima.analysis_engine.impl.AnalysisEngineManagementImpl;
-import org.apache.uima.analysis_engine.metadata.AnalysisEngineMetaData;
import org.apache.uima.cas.CAS;
import org.apache.uima.cas.impl.CASImpl;
+import org.apache.uima.collection.base_cpm.CasObjectProcessor;
import org.apache.uima.resource.Parameter;
import org.apache.uima.resource.Resource;
import org.apache.uima.resource.ResourceInitializationException;
import org.apache.uima.resource.ResourceServiceException;
+import org.apache.uima.resource.ResourceServiceStub;
import org.apache.uima.resource.metadata.ProcessingResourceMetaData;
import org.apache.uima.resource.metadata.ResourceMetaData;
import org.apache.uima.util.SaxDeserializer;
@@ -141,7 +142,7 @@ public class VinciAnalysisEngineServiceS
/**
- * @see org.apache.uima.resource.service.ResourceServiceStub#callGetMetaData()
+ * @see ResourceServiceStub#callGetMetaData()
*/
public ResourceMetaData callGetMetaData() throws ResourceServiceException {
try {
@@ -191,14 +192,14 @@ public class VinciAnalysisEngineServiceS
}
/**
- * @see org.apache.uima.analysis_engine.service.AnalysisEngineServiceStub#callProcess(CAS)
+ * @see AnalysisEngineServiceStub#callProcess(CAS)
*/
public void callProcess(CAS aCAS) throws ResourceServiceException {
doProcess(aCAS);
}
/**
- * @see CasObjectProcessorServiceStub#callProcessCas(CAS)
+ * @see CasObjectProcessor#processCas(CAS)
*/
public void callProcessCas(CAS aCAS) throws ResourceServiceException {
doProcess(aCAS);
@@ -236,14 +237,14 @@ public class VinciAnalysisEngineServiceS
}
/**
- * @see org.apache.uima.resource.service.impl.ResourceServiceStub#destroy()
+ * @see ResourceServiceStub#destroy()
*/
public void destroy() {
mVinciClient.close();
}
/**
- * @see org.apache.uima.collection.impl.service.CasObjectProcessorServiceStub#callBatchProcessComplete()
+ * @see CasObjectProcessor#batchProcessComplete(org.apache.uima.util.ProcessTrace)
*/
public void callBatchProcessComplete() throws ResourceServiceException {
try {
@@ -259,7 +260,7 @@ public class VinciAnalysisEngineServiceS
}
/**
- * @see org.apache.uima.collection.impl.service.CasObjectProcessorServiceStub#callCollectionProcessComplete()
+ * @see CasObjectProcessor#collectionProcessComplete(org.apache.uima.util.ProcessTrace)
*/
public void callCollectionProcessComplete() throws ResourceServiceException {
try {
@@ -276,7 +277,7 @@ public class VinciAnalysisEngineServiceS
}
/**
- * @see org.apache.uima.collection.impl.service.CasObjectProcessorServiceStub#callIsReadOnly()
+ * @see CasObjectProcessor#isReadOnly()
*/
public boolean callIsReadOnly() throws ResourceServiceException {
try {
@@ -295,7 +296,7 @@ public class VinciAnalysisEngineServiceS
}
/**
- * @see org.apache.uima.collection.impl.service.CasObjectProcessorServiceStub#callIsStateless()
+ * @see CasObjectProcessor#isStateless()
*/
public boolean callIsStateless() throws ResourceServiceException {
try {
Modified: uima/uimaj/trunk/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciAnalysisEngineService_impl.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciAnalysisEngineService_impl.java?rev=1521265&r1=1521264&r2=1521265&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciAnalysisEngineService_impl.java (original)
+++ uima/uimaj/trunk/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciAnalysisEngineService_impl.java Mon Sep 9 19:41:16 2013
@@ -74,8 +74,10 @@ public class VinciAnalysisEngineService_
/**
* Instantiate Analysis Engine from a given descriptor, debug mode, and instance Id
*
- * @param aResourceSpecifierPath -
- * descriptor location
+ * @param serviceConfigPath descriptor location
+ * @param debug
+ * @param instanceId
+ * @throws Exception
*/
public VinciAnalysisEngineService_impl(String serviceConfigPath, boolean debug, String instanceId)
throws Exception {
@@ -86,8 +88,8 @@ public class VinciAnalysisEngineService_
/**
* Instantiate Analysis Engine service from a given descriptor - possibly in debug mode.
*
- * @param aResourceSpecifierPath -
- * descriptor location
+ * @param serviceConfigPath descriptor location
+ * @param debug
*/
public VinciAnalysisEngineService_impl(String serviceConfigPath, boolean debug) throws Exception {
this.debug = debug;
@@ -128,8 +130,7 @@ public class VinciAnalysisEngineService_
/**
* Instantiate Analysis Engine service from a given descriptor.
*
- * @param aResourceSpecifierPath -
- * descriptor location
+ * @param serviceConfigPath descriptor location
*/
public VinciAnalysisEngineService_impl(String serviceConfigPath) throws Exception {
this(serviceConfigPath, false);
@@ -208,7 +209,7 @@ public class VinciAnalysisEngineService_
* VINCI:COMMAND. Currently, two such operations are supported: 1) Annotate - triggers document
* analysis 2) GetData - triggers return of the AE meta data ( descriptor)
*
- * @param {@link org.apache.vinci.transport.Transportable} -
+ * @param doc {@link org.apache.vinci.transport.Transportable} -
* a VinciFrame containing client request
* @return {@link org.apache.vinci.transport.Transportable} - a VinciFrame containg result of
* performing the service
Modified: uima/uimaj/trunk/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciBinaryAnalysisEngineServiceStub.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciBinaryAnalysisEngineServiceStub.java?rev=1521265&r1=1521264&r2=1521265&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciBinaryAnalysisEngineServiceStub.java (original)
+++ uima/uimaj/trunk/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciBinaryAnalysisEngineServiceStub.java Mon Sep 9 19:41:16 2013
@@ -39,6 +39,7 @@ import org.apache.uima.internal.util.Ser
import org.apache.uima.resource.Parameter;
import org.apache.uima.resource.ResourceInitializationException;
import org.apache.uima.resource.ResourceServiceException;
+import org.apache.uima.resource.ResourceServiceStub;
import org.apache.uima.resource.metadata.ResourceMetaData;
import org.apache.uima.util.SaxDeserializer;
import org.apache.vinci.transport.VinciClient;
@@ -144,7 +145,7 @@ public class VinciBinaryAnalysisEngineSe
}
/**
- * @see org.apache.uima.resource.service.ResourceServiceStb#callGetMetaData()
+ * @see ResourceServiceStub#callGetMetaData()
*/
public ResourceMetaData callGetMetaData() throws ResourceServiceException {
try {
@@ -195,7 +196,7 @@ public class VinciBinaryAnalysisEngineSe
}
/**
- * @see org.apache.uima.analysis_engine.service.AnalysisEngineServiceStub#callProcess(CAS)
+ * @see AnalysisEngineServiceStub#callProcess(CAS)
*/
public void callProcess(CAS aCAS) throws ResourceServiceException {
try {
@@ -228,7 +229,7 @@ public class VinciBinaryAnalysisEngineSe
}
/**
- * @see org.apache.uima.analysis_engine.service.AnalysisEngineServiceStub#callBatchProcessComplete()
+ * @see AnalysisEngineServiceStub#callBatchProcessComplete()
*/
public void callBatchProcessComplete() throws ResourceServiceException {
try {
@@ -244,7 +245,7 @@ public class VinciBinaryAnalysisEngineSe
}
/**
- * @see org.apache.uima.analysis_engine.service.AnalysisEngineServiceStub#callCollectionProcessComplete()
+ * @see AnalysisEngineServiceStub#callCollectionProcessComplete()
*/
public void callCollectionProcessComplete() throws ResourceServiceException {
try {
@@ -261,7 +262,7 @@ public class VinciBinaryAnalysisEngineSe
}
/**
- * @see org.apache.uima.resource.service.impl.ResourceServiceStub#destroy()
+ * @see ResourceServiceStub#destroy()
*/
public void destroy() {
mVinciClient.close();
Modified: uima/uimaj/trunk/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciBinaryAnalysisEngineService_impl.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciBinaryAnalysisEngineService_impl.java?rev=1521265&r1=1521264&r2=1521265&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciBinaryAnalysisEngineService_impl.java (original)
+++ uima/uimaj/trunk/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciBinaryAnalysisEngineService_impl.java Mon Sep 9 19:41:16 2013
@@ -83,8 +83,9 @@ public class VinciBinaryAnalysisEngineSe
/**
* Instantiate Analysis Engine from a given descriptor - possibly in debug mode.
*
- * @param aResourceSpecifierPath -
- * descriptor location
+ * @param serviceConfigPath descriptor location
+ * @param debug
+ * @param instanceId
*/
public VinciBinaryAnalysisEngineService_impl(String serviceConfigPath, boolean debug,
String instanceId) throws Exception {
@@ -96,8 +97,8 @@ public class VinciBinaryAnalysisEngineSe
/**
* Instantiate Analysis Engine from a given descriptor - possibly in debug mode.
*
- * @param aResourceSpecifierPath -
- * descriptor location
+ * @param serviceConfigPath descriptor location
+ * @param debug
*/
public VinciBinaryAnalysisEngineService_impl(String serviceConfigPath, boolean debug)
throws Exception {
@@ -131,8 +132,7 @@ public class VinciBinaryAnalysisEngineSe
/**
* Instantiate Analysis Engine from a given descriptor.
*
- * @param aResourceSpecifierPath -
- * descriptor location
+ * @param serviceConfigPath descriptor location
*/
public VinciBinaryAnalysisEngineService_impl(String serviceConfigPath) throws Exception {
this(serviceConfigPath, false);
@@ -233,7 +233,7 @@ public class VinciBinaryAnalysisEngineSe
* VINCI:COMMAND. Currently, two such operations are supported: 1) Annotate - triggers document
* analysis 2) GetData - triggers return of the AE meta data ( descriptor)
*
- * @param {@link org.apache.vinci.transport.Transportable} -
+ * @param doc {@link org.apache.vinci.transport.Transportable} -
* a VinciFrame containing client request
* @return {@link org.apache.vinci.transport.Transportable} - a VinciFrame containg result of
* performing the service
Modified: uima/uimaj/trunk/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/util/Descriptor.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/util/Descriptor.java?rev=1521265&r1=1521264&r2=1521265&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/util/Descriptor.java (original)
+++ uima/uimaj/trunk/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/util/Descriptor.java Mon Sep 9 19:41:16 2013
@@ -59,8 +59,7 @@ public class Descriptor extends DefaultH
/**
* Constructor responsible for parsing the descriptor file named in filePath.
*
- * @param Fully
- * qualified path the xml descriptor.
+ * @param filePath Fully qualified path the xml descriptor.
*/
public Descriptor(String filePath) {
try {
Modified: uima/uimaj/trunk/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/util/UimaSaxVinciFrameBuilder.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/util/UimaSaxVinciFrameBuilder.java?rev=1521265&r1=1521264&r2=1521265&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/util/UimaSaxVinciFrameBuilder.java (original)
+++ uima/uimaj/trunk/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/util/UimaSaxVinciFrameBuilder.java Mon Sep 9 19:41:16 2013
@@ -48,7 +48,7 @@ public class UimaSaxVinciFrameBuilder ex
/**
* Overridden to supress document content and include annotation spans.
*
- * @see SaxVinciFrameBuilder#getLeafContent(String, attributes, StringBuffer)
+ * @see SaxVinciFrameBuilder#getLeafContent(String, Attributes, StringBuffer)
*/
protected String getLeafContent(String aFrameName, Attributes aAttributes,
StringBuffer aContentBuf) {