edu.uci.isr.xarch
Class SequenceOrder

java.lang.Object
  edu.uci.isr.xarch.SequenceOrder

public class SequenceOrder

extends Object

Describes an order of child elements for a parent element, which can be used for sorting children.

Author:

Eric M. Dashofy (edashofy@ics.uci.edu)

Field Summary

protected Vector

qNames Qualified names in the sequence.

Constructor Summary

SequenceOrder()
Creates an empty sequence order.

SequenceOrder(QName name)
Creates a sequence order of size 1 with the given qualified name.

SequenceOrder(QName[] names)
Creates a sequence order from an array of qualified names.

SequenceOrder(SequenceOrder baseOrder)
Creates a sequence order from another sequence order.

SequenceOrder(SequenceOrder baseOrder, QName name)
Creates a sequence order from the concatenation of a base order and a single additional name.

SequenceOrder(SequenceOrder baseOrder, QName[] names)
Creates a sequence order from the concatenation of a base order and an array of additional names.

SequenceOrder(SequenceOrder baseOrder, SequenceOrder appendedOrder)
Creates a sequence order from the concatenation of a base order and an appendix order.

Method Summary

void	addName(QName name) Adds a name to the end of the sequence order.
void	addNames(QName[] names) Adds a set of names to the end of the sequence order
Enumeration	elements() Return an enumeration of the elements in this sequence order.
QName	getName(int index) Gets an element of the sequence order at the given position in the order.
QName[]	getNames() Gets this sequence order as an array of names.
void	removeName(QName name) Removes the given name from the sequence order.
int	size() Returns the size of this sequence order.

Methods inherited from class java.lang.Object

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

Field Detail

qNames

protected Vector qNames

Qualified names in the sequence.

Constructor Detail

SequenceOrder

public SequenceOrder()

Creates an empty sequence order.

SequenceOrder

public SequenceOrder(QName name)

Creates a sequence order of size 1 with the given qualified name.

Parameters:

name - QName to put in the sequence.

SequenceOrder

public SequenceOrder(QName[] names)

Creates a sequence order from an array of qualified names.

Parameters:

names - QNames, in order, to put in the sequence.

SequenceOrder

public SequenceOrder(SequenceOrder baseOrder)

Creates a sequence order from another sequence order.

Parameters:

baseOrder - Order to copy into this one.

SequenceOrder

public SequenceOrder(SequenceOrder baseOrder,
                     SequenceOrder appendedOrder)

Creates a sequence order from the concatenation of a base order and an appendix order.

Parameters:

baseOrder - Start of sequence

appendedOrder - Sequence to be appended to baseOrder.

SequenceOrder

public SequenceOrder(SequenceOrder baseOrder,
                     QName name)

Creates a sequence order from the concatenation of a base order and a single additional name.

Parameters:

baseOrder - Start of sequence

name - Name to append to baseOrder

SequenceOrder

public SequenceOrder(SequenceOrder baseOrder,
                     QName[] names)

Creates a sequence order from the concatenation of a base order and an array of additional names.

Parameters:

baseOrder - Start of sequence

names - Names to append to baseOrder

Method Detail

size

public int size()

Returns the size of this sequence order.

Returns:

size of the sequence order.

addName

public void addName(QName name)

Adds a name to the end of the sequence order.

Parameters:

name - Name to add.

addNames

public void addNames(QName[] names)

Adds a set of names to the end of the sequence order

Parameters:

names - Names to add.

getName

public QName getName(int index)

Gets an element of the sequence order at the given position in the order.

Parameters:

index - Index of order at which to retrieve element.

Returns:

Name at position index in order.

getNames

public QName[] getNames()

Gets this sequence order as an array of names.

Returns:

Names in this sequence order.

removeName

public void removeName(QName name)

Removes the given name from the sequence order.

Parameters:

name - Name to remove.

elements

public Enumeration elements()

Return an enumeration of the elements in this sequence order.

Returns:

Enumeration of elements in this sequence order.