org.ceryle.xtm
Class XtmResourceData

java.lang.Object
  org.ceryle.xtm.XtmNode
      org.ceryle.xtm.XtmResourceData

All Implemented Interfaces:

Comparable, Iterator, Constants

public class XtmResourceData
extends XtmNode
implements Comparable

Defines a resource data object, as occurs in a topic map, such that instances of this class are objects representing resource data, designed to assist in building in-memory representations via the XtmProcessor class. XtmResourceData objects are not representations of XTM <resourceData> Elements.

Since:

JDK1.3

Version:

$Id: XtmResourceData.java,v 3.3 2007-06-15 12:10:35 altheim Exp $

Author:

Murray Altheim

See Also:

XtmNode

Field Summary

Fields inherited from class org.ceryle.xtm.XtmNode

ASSOCIATION_NODE, BASENAME_NODE, BASENAMESTRING_NODE, COMMENT_NODE, DOCUMENT_NODE, GrpSep, GRPSEP, id, INSTANCEOF_NODE, MEMBER_NODE, MERGEMAP_NODE, NODE, NonType, NONTYPE, OCCURRENCE_NODE, PARAMETERS_NODE, PROCESSING_INSTRUCTION_NODE, RecSep, RECSEP, REFERENCE_NODE, RESOURCEDATA_NODE, RESOURCEREF_NODE, ROLESPEC_NODE, SCOPE_NODE, SUBJECTIDENTITY_NODE, SUBJECTINDICATORREF_NODE, TOPIC_NODE, TOPICMAP_NODE, TOPICREF_NODE, VARIANT_NODE, VARIANTNAME_NODE

Fields inherited from interface org.ceryle.util.Constants

Amp, AMP, Apos, APOS, APP_NAME, APP_VERSION_NAME, APP_VERSION_NUMBER, AT, BANG, BAR, BIT_dev, BIT_http, BIT_ignoreCom, BIT_merge, BIT_none, BIT_noPreload, BIT_simple, BIT_ui, BIT_unused1, BIT_unused2, BIT_unused3, BIT_validating, BIT_verbose, BIT_xcatalog, BIT_xlink, BIT_xmlnsAware, BIT_xsd, BROKB, BSlash, BSLASH, CERYLE_CREDITS_FILE, CERYLE_DATA_DIR, CERYLE_HIST_FILE, CERYLE_LICENSE_FILE, CERYLE_PREF_FILE, CERYLE_PROP, CERYLE_PROP_BASE, CERYLE_PROP_FILE, CERYLE_RSRC_DIR, CERYLE_THANKS_FILE, CFLEX, Colon, COLON, Comma, COMMA, CR, CRet, Dash, DASH, DEFAULT_DIRECTORY, DEVELOPER, DOLR, Dot, DOT, EIGHT, Ellip, EOF, EqQuot, EQUAL, Equals, False, FALSE, FileProt, Filesep, FileURL, Five, FIVE, FONTSIZES, Four, FOUR, FSchar, GCOL_PROP, GRAPH_PROP, GRAVE, GT, Hash, HASH, HOME_DIRECTORY, HOME_DIRECTORY_PATH, HOME_DIRECTORY_URL, HTML, HttpProt, HttpURL, INDENT, INDENT_0, INDENT_1, INDENT_10, INDENT_2, INDENT_3, INDENT_4, INDENT_5, INDENT_6, INDENT_7, INDENT_8, INDENT_9, INIT, LCURL, LCurly, LF, LFS, Localhost, LPAR, LParen, LS, LSBrkt, LSBrkt2, LSQB, LT, MT, NBSP, NEL, NINE, NL, NL20x, NLchar, No, Null, NULL, NULL_STATE, NumParams, One, ONE, Pathsep, Percent, PERO, PLUS, Prcnt, PS, QMark, QMARK, Quot, QUOT, RCURL, RCurly, RESOURCE_BUNDLE, RPAR, RParen, RSBrkt, RSBrkt2, RSQB, Semi, SEMI, SEVEN, SIX, Slash, SLASH, SP, SPACE, Stago, Star, STAR, Tab, TAB, Tee, Three, THREE, Tilde, TILDE, TM_PROP, True, TRUE, Two, TWO, Under, UNDER, URI, URL, VBar, WIKI_PROP, XNodePfx, XNodeURL, XtmExt, Yes, Zero, ZERO

Constructor Summary

XtmResourceData()
Default constructor.

XtmResourceData(String content)
XtmResourceData constructor with String content.

XtmResourceData(String id, String content)
XtmResourceData constructor with a provided ID and String content.

Method Summary

int	compareTo(Object o) Compares the String content of this XtmResourceData with the provided Object for order.
String	getContent() Returns the String content of this XtmResourceData.
String	getHash() Return a String hashcode generated from this XtmResourceData's content.
String	getName() Returns a String containing the name of this XTM element type.
short	getNodeType() A short integer indicating what type of node this is.
void	setContent(String content) Sets the content of this XtmResourceData to the String content.

Methods inherited from class org.ceryle.xtm.XtmNode

addPI, getID, getPI, getPIs, hasNext, next, remove, removePI, setID

Methods inherited from class java.lang.Object

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

Constructor Detail

XtmResourceData

public XtmResourceData()
                throws XtmException

Default constructor.

Throws:

XtmException

XtmResourceData

public XtmResourceData(String content)
                throws XtmException

XtmResourceData constructor with String content.

Throws:

XtmException

XtmResourceData

public XtmResourceData(String id,
                       String content)
                throws XtmException

XtmResourceData constructor with a provided ID and String content.

Throws:

XtmException - if the provided ID is invalid.

Method Detail

getName

public String getName()

Returns a String containing the name of this XTM element type.

Overrides:

getName in class XtmNode

getNodeType

public short getNodeType()

A short integer indicating what type of node this is. The named constants for this value are defined in the org.ceryle.XtmNode class.

Overrides:

getNodeType in class XtmNode

getHash

public String getHash()

Return a String hashcode generated from this XtmResourceData's content.

setContent

public void setContent(String content)

Sets the content of this XtmResourceData to the String content.

getContent

public String getContent()

Returns the String content of this XtmResourceData.

compareTo

public int compareTo(Object o)

Compares the String content of this XtmResourceData with the provided Object for order.

Specified by:

compareTo in interface Comparable