Package org.apache.uima.tools.util.htmlview

Class AnnotationViewGenerator

java.lang.Object
org.apache.uima.tools.util.htmlview.AnnotationViewGenerator
public class AnnotationViewGenerator extends Object
Utility that uses XSL stylesheets to produce an HTML view (w/ Javascript) of an annotated document.

  • Constructor Summary

    Constructors
    Constructor
    Description
    AnnotationViewGenerator(File aOutputDir)
    Creates a new AnnotationViewGenerator.

  • Method Summary

    Modifier and Type
    Method
    Description
    static String
    autoGenerateStyleMap(org.apache.uima.analysis_engine.metadata.AnalysisEngineMetaData aTaeMetaData)
    Automatically generates a style map for the given text analysis engine.
    static String
    autoGenerateStyleMap(org.apache.uima.resource.metadata.TypeSystemDescription aTypeSystem)
    Automatically generates a style map for the given type system.
    void
    autoGenerateStyleMapFile(org.apache.uima.analysis_engine.AnalysisEngine aAE, File aStyleMapFile)
    Automatically generates a style map file for the given analysis engine.
    void
    autoGenerateStyleMapFile(org.apache.uima.analysis_engine.metadata.AnalysisEngineMetaData aMetaData, File aStyleMapFile)
    Automatically generates a style map file for the given analysis engine metadata.
    void
    autoGenerateStyleMapFile(org.apache.uima.resource.metadata.TypeSystemDescription aTypeSystem, File aStyleMapFile)
    Automatically generates a style map file for the given type system.
    void
    processDocument(File aInlineXmlDoc)
    Processes an annotated document using the docFrame.xsl stylsheet generated by a previous call to processStyleMap(File).
    void
    processStyleMap(File aStyleMap)
    Processes a user-specified file map and produces three outputs: annotations.css - A CSS stylesheet for the annotation viewer legend.html - HTML document for legend (bottom pane of viewer) docFrame.xsl - An XSL stylesheet to be applied to annotated documents during calls to processDocument(File).

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • AnnotationViewGenerator

      public AnnotationViewGenerator(File aOutputDir)
      Creates a new AnnotationViewGenerator.
      Parameters:
      aOutputDir - directory in which this program will write its output files.

  • Method Details

    • processStyleMap

      public void processStyleMap(File aStyleMap) throws TransformerException
      Processes a user-specified file map and produces three outputs:
      • annotations.css - A CSS stylesheet for the annotation viewer
      • legend.html - HTML document for legend (bottom pane of viewer)
      • docFrame.xsl - An XSL stylesheet to be applied to annotated documents during calls to processDocument(File).
      Parameters:
      aStyleMap - path to style map to be processed
      Throws:
      TransformerException - the transformer exception

    • processDocument

      public void processDocument(File aInlineXmlDoc) throws TransformerException
      Processes an annotated document using the docFrame.xsl stylsheet generated by a previous call to processStyleMap(File). Generates a file named docView.html, which represents the HTML view of the annotated document.
      Parameters:
      aInlineXmlDoc - path to annotated document to be processed
      Throws:
      TransformerException - the transformer exception

    • autoGenerateStyleMap

      public static String autoGenerateStyleMap(org.apache.uima.analysis_engine.metadata.AnalysisEngineMetaData aTaeMetaData)
      Automatically generates a style map for the given text analysis engine. The style map will be returned as an XML string.
      Parameters:
      aTaeMetaData - Metadata of the Text Analysis Engine whose outputs will be viewed using the generated style map.
      Returns:
      a String containing the XML style map

    • autoGenerateStyleMap

      public static String autoGenerateStyleMap(org.apache.uima.resource.metadata.TypeSystemDescription aTypeSystem)
      Automatically generates a style map for the given type system. The style map will be returned as an XML string.
      Parameters:
      aTypeSystem - the type system for which a style map will be generated
      Returns:
      a String containing the XML style map

    • autoGenerateStyleMapFile

      public void autoGenerateStyleMapFile(org.apache.uima.analysis_engine.AnalysisEngine aAE, File aStyleMapFile) throws IOException
      Automatically generates a style map file for the given analysis engine. The style map will be written to the file aStyleMapFile.
      Parameters:
      aAE - the Analysis Engine whose outputs will be viewed using the generated style map.
      aStyleMapFile - file to which autogenerated style map will be written
      Throws:
      IOException - Signals that an I/O exception has occurred.

    • autoGenerateStyleMapFile

      public void autoGenerateStyleMapFile(org.apache.uima.analysis_engine.metadata.AnalysisEngineMetaData aMetaData, File aStyleMapFile) throws IOException
      Automatically generates a style map file for the given analysis engine metadata. The style map will be written to the file aStyleMapFile.
      Parameters:
      aMetaData - Metadata of the Analysis Engine whose outputs will be viewed using the generated style map.
      aStyleMapFile - file to which autogenerated style map will be written
      Throws:
      IOException - Signals that an I/O exception has occurred.

    • autoGenerateStyleMapFile

      public void autoGenerateStyleMapFile(org.apache.uima.resource.metadata.TypeSystemDescription aTypeSystem, File aStyleMapFile) throws IOException
      Automatically generates a style map file for the given type system. The style map will be written to the file aStyleMapFile.
      Parameters:
      aTypeSystem - the type system for which a style map will be generated
      aStyleMapFile - file to which autogenerated style map will be written
      Throws:
      IOException - Signals that an I/O exception has occurred.