com.raritantechnologies.federated.eRoom
Class ERoomItem

java.lang.Object
  com.raritantechnologies.federated.eRoom.ERoomItem

All Implemented Interfaces:

IConfigurable

public class ERoomItem

extends java.lang.Object

implements IConfigurable

Defines how an ERoom item is to be mapped to a RTI Result.

<ERoomItem name="erItemTypeDBPage" > <Structure> <Database > <Rows> <Item> <Name/> <ID /> <RelativeURL/> <URL/> <Size/> <Cells> <DBCell" > <ColumnID" /> <Content" /> <DisplayContent" /> <Name" /> </DBCell> </Cells> </Item> </Rows> </Database> </Structure> <FieldMap> <Field ID="fieldID in result" xPath="[ xPath to SOAP node ]" /> <!-- Fields can use multiple sub fields to create a value --> <Field ID="[ result field ID ]" xPath="[ xPath to SOAP node ]" > <Template> template with { } placeholders for SOAP component values </Template> </Field> <CompositeField ID="[ fieldID in result ]"> <Template> template with { } placeholders for sub field values </Template> <Field ID="[ result field ID ]" xPath="[ xPath to SOAP node ]" /> </CompositeField> <DateField ID="[ fieldID in result ]" xPath="[ xPath(s) to SOAP node separated by '|' ]" select="[ALL|LATEST|EARLIEST]" /> </FieldMap> </ERoomItem>

Constructor Summary

ERoomItem()

Method Summary

void	addDocumentAcquisitionTime(long docAcquisitionTime)
void	addDocumentSize(long documentSize)
void	addFailedMetadataAcquisitionTime(long failedMetadataAcquisitionTime)
void	addFileIOTime(long fileIOTime)
void	addMessageElements(javax.xml.soap.SOAPElement seGetProperties)
void	addMetadataAcquisitionTime(long metadataAcquisitionTime)
java.lang.String	getConfigurationXML()
LongStatistics	getDocumentAcquisitionStatistics()
LongStatistics	getDocumentSizeStatistics()
LongStatistics	getFailedMetadataAcquisitionStatistics()
LongStatistics	getFileIOStatistics()
java.lang.String	getItemsPath(java.lang.String containerType)
LongStatistics	getMetadataAcquisitionStatistics()
IResult	getResult(MessageElement dataElem)
java.util.Set	getSpecialCaseItems()
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

ERoomItem

public ERoomItem()

Method Detail

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

getDocumentAcquisitionStatistics

public LongStatistics getDocumentAcquisitionStatistics()

getDocumentSizeStatistics

public LongStatistics getDocumentSizeStatistics()

getFileIOStatistics

public LongStatistics getFileIOStatistics()

getMetadataAcquisitionStatistics

public LongStatistics getMetadataAcquisitionStatistics()

getFailedMetadataAcquisitionStatistics

public LongStatistics getFailedMetadataAcquisitionStatistics()

addDocumentAcquisitionTime

public void addDocumentAcquisitionTime(long docAcquisitionTime)

addDocumentSize

public void addDocumentSize(long documentSize)

addMetadataAcquisitionTime

public void addMetadataAcquisitionTime(long metadataAcquisitionTime)

addFailedMetadataAcquisitionTime

public void addFailedMetadataAcquisitionTime(long failedMetadataAcquisitionTime)

addFileIOTime

public void addFileIOTime(long fileIOTime)

getConfigurationXML

public java.lang.String getConfigurationXML()

addMessageElements

public void addMessageElements(javax.xml.soap.SOAPElement seGetProperties)

getResult

public IResult getResult(MessageElement dataElem)

getItemsPath

public java.lang.String getItemsPath(java.lang.String containerType)

getSpecialCaseItems

public java.util.Set getSpecialCaseItems()