Class PMUimaAgent
java.lang.Object
org.apache.uima.tools.pear.merger.PMUimaAgent
The
PMUimaAgent class implements UIMA-based utility methods utilized by the
PMController class. The class allows generating analysis engine descriptor
for output aggregate AE based on the specified input descriptors.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescription(package private) static AnalysisEngineDescriptioncreateAggregateDescription(String aggCompName, File aggRootDir, InstallationDescriptor[] dlgInstDescs) Creates UIMA aggregate analysis engine description object, based on given aggregate component name (ID), aggregate root directory and array of delegate installation descriptors.private static Capability[]mergeCapabilities(ArrayList allCapabilities, ResourceSpecifierFactory rsFactory) Merges sourceCapabilityobjects specified in a givenArrayList, creating oneCapabilityobject that contains all non-duplicated inputs and outputs of the sourceCapabilityobjects.private static ResourceSpecifierretrieveDelegateSpecifier(File aggRootDir, InstallationDescriptor dlgInstDesc) CreatesResourceSpecifierobject for a delegate component descriptor, specified by a givenInstallationDescriptorobject.(package private) static voidsaveAggregateDescription(AnalysisEngineDescription aggDescription, File aggDescFile) Saves a given UIMA aggregate component desciption in a specified XML descriptor file.(package private) static StringtoXmlString(XMLizable content) Converts a givenXMLizableobject to String.
-
Constructor Details
-
PMUimaAgent
public PMUimaAgent()
-
-
Method Details
-
createAggregateDescription
static AnalysisEngineDescription createAggregateDescription(String aggCompName, File aggRootDir, InstallationDescriptor[] dlgInstDescs) Creates UIMA aggregate analysis engine description object, based on given aggregate component name (ID), aggregate root directory and array of delegate installation descriptors. Returns the UIMA aggregate analysis engine description object.- Parameters:
aggCompName- The given aggregate component name (ID).aggRootDir- The given aggregate root directory.dlgInstDescs- The given array of delegate installation descriptors.- Returns:
- The UIMA aggregate analysis engine description object.
-
mergeCapabilities
private static Capability[] mergeCapabilities(ArrayList allCapabilities, ResourceSpecifierFactory rsFactory) Merges sourceCapabilityobjects specified in a givenArrayList, creating oneCapabilityobject that contains all non-duplicated inputs and outputs of the sourceCapabilityobjects. Returns an array ofCapabilityobjects, containing the merged object.- Parameters:
allCapabilities- The givenArrayListof the sourceCapabilityobjects.rsFactory- TheResourceSpecifierFactoryobject used to create newCapabilityobject.- Returns:
- Array of
Capabilityobjects, containing the merged object.
-
retrieveDelegateSpecifier
private static ResourceSpecifier retrieveDelegateSpecifier(File aggRootDir, InstallationDescriptor dlgInstDesc) throws IOException, InvalidXMLException CreatesResourceSpecifierobject for a delegate component descriptor, specified by a givenInstallationDescriptorobject. Returns the delegate componentResourceSpecifierobject.- Parameters:
aggRootDir- The given aggregate root directory.dlgInstDesc- The given delegateInstallationDescriptorobject.- Returns:
- The given delegate component
ResourceSpecifierobject. - Throws:
IOException- If an I/O exception occurred while creating XML input source.InvalidXMLException- IfResourceSpecifierobject cannot be created from the specified descriptor.
-
saveAggregateDescription
static void saveAggregateDescription(AnalysisEngineDescription aggDescription, File aggDescFile) throws IOException Saves a given UIMA aggregate component desciption in a specified XML descriptor file.- Parameters:
aggDescription- The given UIMA aggregate component desciption.aggDescFile- The given XML descriptor file.- Throws:
IOException- If an I/O exception occurrs.
-
toXmlString
Converts a givenXMLizableobject to String. This method is useful for debugging.- Parameters:
content- The givenXMLizableobject- Returns:
- A String that represents the given
XMLizableobject.
-