prajna.structure.accessor

Class XmlDataAccessor

java.lang.Object

prajna.structure.AbstractDataAccessor<DataRecord,DataRecord>

prajna.structure.accessor.RecordAccessor

prajna.structure.accessor.XmlDataAccessor

All Implemented Interfaces:

DataAccessor<DataRecord,DataRecord>

public class XmlDataAccessor
extends RecordAccessor

Data accessor for reading semi-structured XML files. This accessor creates DataRecords based upon the record identifier for each data template. The child elements within that record are stored as fields within the data record. For instance, if the record identifier were car, the following XML would create a data record with source fields for Make, Model, and Year:

 <car>
     <Make>Honda</Make>
     <Model>Odyssey</Model>
     <Year>2013</Year>
 </car>
 

Author:

Edward Swing

Constructor Summary

Constructors

Constructor and Description
XmlDataAccessor()

Method Summary

Methods

Modifier and Type	Method and Description
protected java.util.Set<DataRecord>	retrieveRecords(DataTemplate template) Retrieve a set of data records for a particular DataTemplate.
void	setInitParameters(java.util.Map<java.lang.String,java.lang.String> parameters) Set any initialization parameters required by this data accessor
void	setQuery(java.lang.String queryString) Set the query string used to retrieve records.

Methods inherited from class prajna.structure.accessor.RecordAccessor

addFieldHandler, addToGraph, addToTree, createReferenceNode, extendGraph, extendTree, getDataset, getFieldHandler, getGraph, getGrid, getMaxRecords, getReasoner, getStructureReasoners, getTree, setMaxRecords, setReasoner, setReasoner

Methods inherited from class prajna.structure.AbstractDataAccessor

addStructure, addTemplate, getDatasetNames, getGraphNames, getGridNames, getSpec, getStructureType, getTemplate, getTemplateNames, getTreeNames, setConfig, setConfigFile, setConfigFile

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlDataAccessor

public XmlDataAccessor()

Method Detail

retrieveRecords

protected java.util.Set<DataRecord> retrieveRecords(DataTemplate template)

Retrieve a set of data records for a particular DataTemplate. This method is used by the various getStructure methods.

Specified by:

retrieveRecords in class RecordAccessor

Parameters:

template - The data template specifying field mappings and descriptions

Returns:

the set of DataRecords for the template

setInitParameters

public void setInitParameters(java.util.Map<java.lang.String,java.lang.String> parameters)

Set any initialization parameters required by this data accessor

Parameters:

parameters - a map of initialization parameters

setQuery

public void setQuery(java.lang.String queryString)

Set the query string used to retrieve records. This method should transform the query string into a format which the accessor can parse. The query string supports a query of the form field=value.

Specified by:

setQuery in class AbstractDataAccessor<DataRecord,DataRecord>

Parameters:

queryString - the query string