org.umber.catalan.process.workers.text
Class TextToXmlCommand

java.lang.Object
  extended byorg.umber.catalan.process.workers.BaseMetadataHolder
      extended byorg.umber.catalan.process.commands.BaseCommand
          extended byorg.umber.catalan.process.workers.text.BaseTextCommand
              extended byorg.umber.catalan.process.workers.text.TextToXmlCommand
All Implemented Interfaces:
ICommand, IMetadataHolder

public class TextToXmlCommand
extends BaseTextCommand

Implementation of "text-to-xml" command.

This class can also be used as a standalone utility, outside the context of a worker runtime, by calling the convertToXml() method directly.

Author:
jsheets

Constructor Summary
TextToXmlCommand()
          Creates a new instance of TextToXmlCommand.
 
Method Summary
 Datum convertToXml(java.lang.String text)
          Converts the given text into a Bellows XML tree.
 void run(CommandContext context)
          Invokes this command against the given workspace with the given runtime properties.
 
Methods inherited from class org.umber.catalan.process.workers.text.BaseTextCommand
convertToArray, extractText, storeText
 
Methods inherited from class org.umber.catalan.process.workers.BaseMetadataHolder
getMetadata, setOptionalProperties, setRequiredProperties, validateProperties, validateType
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.umber.catalan.process.workers.IMetadataHolder
getMetadata, validateProperties, validateType
 

Constructor Detail

TextToXmlCommand

public TextToXmlCommand()
Creates a new instance of TextToXmlCommand.

Method Detail

run

public void run(CommandContext context)
         throws ProcessException
Invokes this command against the given workspace with the given runtime properties. The owning Worker should verify that all required properties are present before invoking run().

Parameters:
context - command context
Throws:
ProcessException - if a fatal error occurs during processing

convertToXml

public Datum convertToXml(java.lang.String text)
Converts the given text into a Bellows XML tree.

Parameters:
text - input text
Returns:
output XML