org.dlese.dpc.suggest

Class SuggestionRecord

java.lang.Object

org.dlese.dpc.suggest.SuggestionRecord

Direct Known Subclasses:

CommentRecord, ResourceRecord

public abstract class SuggestionRecord
extends java.lang.Object

Wrapper providing accessors for a suggestion record, which is represented as a Document of the framework determined by the SchemaHelper attribute.

Version:

$Id: SuggestionRecord.java,v 1.7 2009/03/20 23:34:00 jweather Exp $

Author:

Jonathan Ostwald

Field Summary

Fields

Modifier and Type	Field and Description
protected org.dom4j.Document	doc NOT YET DOCUMENTED
protected DocMap	docMap NOT YET DOCUMENTED

Constructor Summary

Constructors

Constructor and Description
SuggestionRecord(org.dom4j.Document doc, SchemaHelper schemaHelper) Constructor for the SuggestionRecord object

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	get(java.lang.String xpath) Get the value of the node specified by provided xpath.
org.dom4j.Document	getDoc() Gets the doc attribute of the SuggestionRecord object
protected DocMap	getDocMap() Gets the docMap attribute of the SuggestionRecord object
protected void	put(java.lang.String xpath, java.lang.String value) Assign the provided value to the XML Node specified by xpath.

Methods inherited from class java.lang.Object

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

Field Detail

doc

protected org.dom4j.Document doc

NOT YET DOCUMENTED

docMap

protected DocMap docMap

NOT YET DOCUMENTED

Constructor Detail

SuggestionRecord

public SuggestionRecord(org.dom4j.Document doc,
                        SchemaHelper schemaHelper)

Constructor for the SuggestionRecord object

Parameters:

doc - a dom4j.Document

schemaHelper - a SchemaHelper for the doc's metadata format

Method Detail

getDoc

public org.dom4j.Document getDoc()

Gets the doc attribute of the SuggestionRecord object

Returns:

The doc value

getDocMap

protected DocMap getDocMap()

Gets the docMap attribute of the SuggestionRecord object

Returns:

The docMap value

put

protected void put(java.lang.String xpath,
                   java.lang.String value)
            throws java.lang.Exception

Assign the provided value to the XML Node specified by xpath.

Parameters:

xpath - NOT YET DOCUMENTED

value - NOT YET DOCUMENTED

Throws:

java.lang.Exception - NOT YET DOCUMENTED

get

protected java.lang.String get(java.lang.String xpath)

Get the value of the node specified by provided xpath.

Parameters:

xpath - NOT YET DOCUMENTED

Returns:

NOT YET DOCUMENTED