org.ceryle.xtm
Class XtmParameters

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

All Implemented Interfaces:

Comparable, Iterator, Constants

public class XtmParameters
extends XtmNode
implements Comparable

Defines a base name parameter, such that instances of this class are objects representing a collection of XTM parameters. XtmParameters are not representations of XML <parameters> Elements.

Note that this class does not support IDs on parameters.

Since:

JDK1.3

Version:

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

Author:

Murray Altheim

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

XtmParameters(String uri)
Constructor with no provided ID, but including the URI to be used as the xlink:href value of a <topicRef> or a <subjectIndicatorRef> Element, depending on if the URI begins with "#" (i.e., in internal topic reference or not).

XtmParameters(TreeSet xreferences)
Constructor with a TreeSet xrefs containing one or more XtmReference objects indicating the parameters of a variant.

XtmParameters(XtmReference xref)
Constructor with an XtmReference xref indicating the parameters of a variant.

Method Summary

void	addReference(XtmReference xref) Adds the XtmReference xref to the topic references in this XtmParameters.
int	compareTo(Object o) Compares the hash of this XtmParameters with the provided Object for order.
String	getHash() Return an int hashcode generated from this XtmParameters's XtmReferences.
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.
Iterator	getParameters() Returns an Iterator containing the XtmReferences of this XtmParameters object, null if undefined.
boolean	hasParameter(XtmReference xref) Return true if an XtmReference object is found amongst the parameters of this XtmParameters having a URI string matching the one provided.
int	size() Returns the number of XtmReferences contained in this XtmParameters.

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

XtmParameters

public XtmParameters(String uri)

Constructor with no provided ID, but including the URI to be used as the xlink:href value of a <topicRef> or a <subjectIndicatorRef> Element, depending on if the URI begins with "#" (i.e., in internal topic reference or not). This is a convenience method.

XtmParameters

public XtmParameters(XtmReference xref)

Constructor with an XtmReference xref indicating the parameters of a variant.

XtmParameters

public XtmParameters(TreeSet xreferences)

Constructor with a TreeSet xrefs containing one or more XtmReference objects indicating the parameters of a variant.

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

getParameters

public Iterator getParameters()

Returns an Iterator containing the XtmReferences of this XtmParameters object, null if undefined.

hasParameter

public boolean hasParameter(XtmReference xref)

Return true if an XtmReference object is found amongst the parameters of this XtmParameters having a URI string matching the one provided.

addReference

public void addReference(XtmReference xref)

Adds the XtmReference xref to the topic references in this XtmParameters.

size

public int size()

Returns the number of XtmReferences contained in this XtmParameters.

getHash

public String getHash()

Return an int hashcode generated from this XtmParameters's XtmReferences. The hash code is built from a sorted list of int values representing the URIs of the XtmReferences' URIs, with a Unicode RECORD SEPARATOR (U+001E) character as delimiter.

compareTo

public int compareTo(Object o)

Compares the hash of this XtmParameters with the provided Object for order.

Specified by:

compareTo in interface Comparable