com.raritantechnologies.utils.filter
Class DocumentContentHandlerStringFilter

java.lang.Object
  com.raritantechnologies.utils.filter.DocumentContentHandlerStringFilter

All Implemented Interfaces:

IConfigurable, IStringFilter

public class DocumentContentHandlerStringFilter

extends java.lang.Object

implements IStringFilter

StringFilter that uses an IDocumentContentHandler to transform a String to a document content.

For example, used with DocumentumDocumentContentHandler to change a Documentum ObjectID into a document stream. XML Configuration Template:

  <StringFilter class="com.raritantechnologies.utils.filter.DocumentContentHandlerStringFilter"
                   inputParameter="[ name of http parameter that takes StringFilter input string ]"
                   contentHandler="[ name of DocumentContentHandler (optional) ]"
                   returnBase64="[ true|false(default) - return base64 binary if no conversion ]" >

    <ContentHandler class="[ class of com.raritantechnologies.quickstart.userInterface.IDocumentContentHandler ]" >

    </ContentHandler>

    <FixedParameters>
      <Param name="[ name of parameter ]" value="[ parameter value ]" />
    </FixedParameters>

    <StreamFilters>
      <!-- One or more StreamFilter classes to handle binary - text conversion -->
      <StreamFilter class="[ class of com.raritantechnologies.utils.filter.IStreamFilter ]"
                       contentType="[ content type(s) to use filter with ]" >
        <!-- implementation dependent configuration details -->
      </StreamFilter>

  </StringFilter>
 

Developed by Raritan Technologies Inc..

Author:

Ted Sullivan

Field Summary

Fields inherited from interface com.raritantechnologies.utils.filter.IStringFilter

TEMPLATE

Constructor Summary

DocumentContentHandlerStringFilter()

Method Summary

java.lang.String	filterString(java.util.Map parameters, java.lang.String inputString)
java.lang.String	filterString(java.lang.String inputString)
java.lang.String	filterString(java.lang.String sessionID, java.lang.String inputString)
java.lang.String	getConfigurationXML()
java.lang.String	getConfigurationXML(java.lang.String configurationTemplate)
void	getConfigurationXML(java.io.Writer writer)
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentContentHandlerStringFilter

public DocumentContentHandlerStringFilter()

Method Detail

filterString

public java.lang.String filterString(java.lang.String inputString)

Specified by:

filterString in interface IStringFilter

filterString

public java.lang.String filterString(java.util.Map parameters,
                                     java.lang.String inputString)

Specified by:

filterString in interface IStringFilter

filterString

public java.lang.String filterString(java.lang.String sessionID,
                                     java.lang.String inputString)

Specified by:

filterString in interface IStringFilter

initialize

public void initialize(org.w3c.dom.Element elem)

Description copied from interface: IConfigurable

Initializes the object from an XML tag or element. This method is called by the Framework as part of the application initializtion. see ConfigurationManager, XMLConfigurationManager, XMLSearchFieldMapFactory, XMLSearchSourceFactory. Configurable objects that are owned or contained by other configurable objects will be initialized in by the parent object.

Specified by:

initialize in interface IConfigurable

getConfigurationXML

public void getConfigurationXML(java.io.Writer writer)
                         throws java.io.IOException

Throws:

java.io.IOException

getConfigurationXML

public java.lang.String getConfigurationXML()

Specified by:

getConfigurationXML in interface IStringFilter

getConfigurationXML

public java.lang.String getConfigurationXML(java.lang.String configurationTemplate)

Specified by:

getConfigurationXML in interface IStringFilter