org.ceryle.xtm
Class XtmProcessingInstruction

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

All Implemented Interfaces:

Iterator, Constants

public class XtmProcessingInstruction
extends XtmNode

Defines a processing instruction (PI) occurring in a topic map. Note that PIs are not considered part of the document tree and their use is generally custom to a specific application (ie., no such use is defined in the XTM 1.0 Specification).

Since:

JDK1.3

Version:

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

Author:

Murray Altheim

Field Summary

protected String	data A String containing the data (value) of this processing instruction.
protected String	target A String containing the target (name) of this processing instruction.

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

XtmProcessingInstruction(String target, String data)
Constructor with provided target and data.

Method Summary

String	getData() Return as a String representing the data of this XtmProcessingInstruction.
short	getNodeType() A short integer indicating what type of node this is.
String	getTarget() Return as a String representing the data of this XtmProcessingInstruction.
int	length() Return the length of this PI's data in characters as an int.
void	setData(String data) Set the data (value) of this processing instruction to data.

Methods inherited from class org.ceryle.xtm.XtmNode

addPI, getID, getName, 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

Field Detail

target

protected String target

A String containing the target (name) of this processing instruction.

data

protected String data

A String containing the data (value) of this processing instruction.

Constructor Detail

XtmProcessingInstruction

public XtmProcessingInstruction(String target,
                                String data)

Constructor with provided target and data.

Method Detail

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

getTarget

public String getTarget()

Return as a String representing the data of this XtmProcessingInstruction.

Returns:

A String representing the data of this XtmProcessingInstruction.

setData

public void setData(String data)

Set the data (value) of this processing instruction to data.

Parameters:

data - a String containing this PI's data.

getData

public String getData()

Return as a String representing the data of this XtmProcessingInstruction.

Returns:

A String representing the data of this XtmProcessingInstruction.

length

public int length()

Return the length of this PI's data in characters as an int.

Returns:

An int indicating the number of characters in this PI's data, zero if null or empty.