com.raritantechnologies.genericInterface
Class ResultContentHandler

java.lang.Object
  com.raritantechnologies.genericInterface.ResultContentHandler

All Implemented Interfaces:

IConfigurable, java.rmi.Remote, java.io.Serializable

public class ResultContentHandler

extends java.lang.Object

implements IConfigurable, java.rmi.Remote, java.io.Serializable

Provides API (in process) access to IDocumentContentHandlers.

XML Configuration Template:

  <ResultContentHandler contentType="[ name of content handler to be used ]"
                           sourceName="[ name of search source to be used with this content handler ]" >

    <!-- Optional mapping of added request parameters to http request parameters -->
    <RequestParamsMap>
        <Param name="[ name of parameter added to request parameters map ]" requestParameter="[ mapped parameter name ]" />
    </RequestParamsMap>

    <FixedParams>
        <Param requestParameter="[ name of request parameter ]" value="[ its value ]" />
    </FixedParams>

  </ResultContentHandler>
 

See Also:

Serialized Form

Method Summary

void	addRequestParameter(java.lang.String name, java.lang.String value) Adds a parameter to the document content handler request.
DocumentContent	getContent() retrieves the document content in the form of a DocumentContent bean object.
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

Method Detail

addRequestParameter

public void addRequestParameter(java.lang.String name,
                                java.lang.String value)
                         throws java.rmi.RemoteException

Adds a parameter to the document content handler request. See the documentation of the specific content handler implementation.

Throws:

java.rmi.RemoteException

getContent

public DocumentContent getContent()
                           throws java.rmi.RemoteException

retrieves the document content in the form of a DocumentContent bean object.

Throws:

java.rmi.RemoteException

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