Class PMUimaAgent

java.lang.Object
org.apache.uima.tools.pear.merger.PMUimaAgent

public class PMUimaAgent extends Object
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 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 source Capability objects specified in a given ArrayList, creating one Capability object that contains all non-duplicated inputs and outputs of the source Capability objects. Returns an array of Capability objects, containing the merged object.
      Parameters:
      allCapabilities - The given ArrayList of the source Capability objects.
      rsFactory - The ResourceSpecifierFactory object used to create new Capability object.
      Returns:
      Array of Capability objects, containing the merged object.
    • retrieveDelegateSpecifier

      private static ResourceSpecifier retrieveDelegateSpecifier(File aggRootDir, InstallationDescriptor dlgInstDesc) throws IOException, InvalidXMLException
      Creates ResourceSpecifier object for a delegate component descriptor, specified by a given InstallationDescriptor object. Returns the delegate component ResourceSpecifier object.
      Parameters:
      aggRootDir - The given aggregate root directory.
      dlgInstDesc - The given delegate InstallationDescriptor object.
      Returns:
      The given delegate component ResourceSpecifier object.
      Throws:
      IOException - If an I/O exception occurred while creating XML input source.
      InvalidXMLException - If ResourceSpecifier object 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

      static String toXmlString(XMLizable content)
      Converts a given XMLizable object to String. This method is useful for debugging.
      Parameters:
      content - The given XMLizable object
      Returns:
      A String that represents the given XMLizable object.