com.raritantechnologies.xml
Class FieldValueXMLResultRenderer

java.lang.Object
  com.raritantechnologies.xml.FieldValueXMLResultRenderer

All Implemented Interfaces:

IConfigurable, IXMLResultRenderer

public class FieldValueXMLResultRenderer

extends java.lang.Object

implements IXMLResultRenderer

Renders an IResult using an open Field and Value tags design.

XML Configuration Template:

  <XMLResultRenderer class="com.raritantechnologies.xml.FieldValueXMLResultRenderer"
                        recordSetTag="[ name of Record Set tag: default = 'RecordSet' ]"
                        recordTag="[ name of Record (Result) tag default = 'Record' ]"
                        fieldTag="[ name of Field tag default = 'Field' ]"
                        nameTag="[ name of Field Name tag default= 'Name' ]"
                        valueTag="[ name of Field Value tag default= 'Value' ]"
                        multiValueDelimiter=" optional multi value delimiter default = ','"
                        includeFields="[ optional list of fields to include in output - if absent: all fields will be included ]" >

  </XMLResultRenderer>
 

Constructor Summary

FieldValueXMLResultRenderer()

Method Summary

java.lang.String	getXML(IResult result)
java.lang.String	getXML(IResultSet resultSet)
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

FieldValueXMLResultRenderer

public FieldValueXMLResultRenderer()

Method Detail

getXML

public java.lang.String getXML(IResultSet resultSet)

Specified by:

getXML in interface IXMLResultRenderer

getXML

public java.lang.String getXML(IResult result)

Specified by:

getXML in interface IXMLResultRenderer

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