com.raritantechnologies.xml.dataCollection
Class FileXMLDataSource

java.lang.Object
  com.raritantechnologies.xml.dataCollection.FileXMLDataSource

All Implemented Interfaces:

IConfigurable, IXMLDataSource

public class FileXMLDataSource

extends java.lang.Object

implements IXMLDataSource

Implementation of IXMLDataSource that retrieves xml data from one or more files.

XML Configuration Template:

  <XMLSource class="com.raritantechnologies.xml.dataCollection.FileXMLDataSource" 
                filePath="[path to xml file(s)]"
                fileNameParam="[ name of request parameter that contains fileName ]"
                recurseSubdirectories="true|false(default)" 
                eventRecorderName="[name of IEventRecorder System Object]"
                fileNameTag="[ optional tag name to include filename in XML document ]" />
 

Developed by Raritan Technologies .

Author:

Ted Sullivan

Constructor Summary

FileXMLDataSource()

Method Summary

IEventRecorder	getEventRecorder()
java.lang.String	getFilePath()
org.w3c.dom.Document	getNextResult() returns next available document
boolean	getRecurseSubdirectories()
boolean	hasMoreResults() returns true if more results available, false otherwise
void	init(RaritanPageContext rpc) Initialize the source.
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
void	setEventRecorder(IEventRecorder eRecorder)
void	setFilePath(java.lang.String filePath)
void	setRecurseSubdirectories(boolean recurseSubdirectories)
void	shutdown() close all connections, or other application resources.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileXMLDataSource

public FileXMLDataSource()

Method Detail

init

public void init(RaritanPageContext rpc)

Description copied from interface: IXMLDataSource

Initialize the source. Points to the first available XML Result

Specified by:

init in interface IXMLDataSource

hasMoreResults

public boolean hasMoreResults()

Description copied from interface: IXMLDataSource

returns true if more results available, false otherwise

Specified by:

hasMoreResults in interface IXMLDataSource

getNextResult

public org.w3c.dom.Document getNextResult()

Description copied from interface: IXMLDataSource

returns next available document

Specified by:

getNextResult in interface IXMLDataSource

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

shutdown

public void shutdown()

Description copied from interface: IXMLDataSource

close all connections, or other application resources.

Specified by:

shutdown in interface IXMLDataSource

setFilePath

public void setFilePath(java.lang.String filePath)

getFilePath

public java.lang.String getFilePath()

setRecurseSubdirectories

public void setRecurseSubdirectories(boolean recurseSubdirectories)

getRecurseSubdirectories

public boolean getRecurseSubdirectories()

setEventRecorder

public void setEventRecorder(IEventRecorder eRecorder)

getEventRecorder

public IEventRecorder getEventRecorder()