jberd

Class JBerdTagPath

java.lang.Object

jberd.JBerdTagPath

public class JBerdTagPath
extends java.lang.Object

A path locating a tag in the context of an encoded BER document It consists of a series of numbers (tags) separated by periods Because a BER document does not have one root (it may contain many elements at the top level) an artificial root is introduced. Thus all tag paths start with 0. Thus 0.1 identifies an item with a tag of 1 at the top level of the document and 0.1.2 identifies a child of 0.1 with a tag of 2

Constructor Summary

Constructors

Constructor and Description
JBerdTagPath(int tag) create with a single tag
JBerdTagPath(JBerdTagPath parent, int tag) Create a tagpath from a given parent path with a given tag appended
JBerdTagPath(java.lang.String stringRep) Create from a string representation (eg 0.1.2

Method Summary

Modifier and Type	Method and Description
boolean	compare(JBerdTagPath otherOne) compares a tagpath with another
JBerdTagPath	getParent() returns a tag path's parent
boolean	isParent(JBerdTagPath possParent) Returns whether a given tagpath is this tagpath's parent
java.util.Iterator<java.lang.Integer>	iterator() Returns an iterator enabling the integer elements of a tagpath to be enumerated
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

JBerdTagPath

public JBerdTagPath(int tag)

create with a single tag

Parameters:

tag -

JBerdTagPath

public JBerdTagPath(JBerdTagPath parent,
                    int tag)

Create a tagpath from a given parent path with a given tag appended

Parameters:

parent - the given parent

tag - the tag to append

JBerdTagPath

public JBerdTagPath(java.lang.String stringRep)
             throws BERException

Create from a string representation (eg 0.1.2

Parameters:

stringRep - the string representation

Throws:

BERException - thrown if string is not valid, eg does not start 0. or does not consist of period separated numbers

Method Detail

getParent

public JBerdTagPath getParent()

returns a tag path's parent

Returns:

a tag path representing the parent

compare

public boolean compare(JBerdTagPath otherOne)

compares a tagpath with another

Parameters:

otherOne - the tag path to compare with

Returns:

true or false

isParent

public boolean isParent(JBerdTagPath possParent)

Returns whether a given tagpath is this tagpath's parent

Parameters:

possParent - the putative parent

Returns:

true if possParent this path's parent

iterator

public java.util.Iterator<java.lang.Integer> iterator()

Returns an iterator enabling the integer elements of a tagpath to be enumerated

Returns:

Iterator

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

String representation of this tagpath