textractor.acronyms.xml
Class Acronyms

java.lang.Object
  textractor.acronyms.xml.Acronyms

All Implemented Interfaces:

Serializable

public class Acronyms
extends Object
implements Serializable

List of acronym/expansion pairs

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Acronyms()

Method Summary

void	addAcronymsItem(AcronymsItem vAcronymsItem)
void	addAcronymsItem(int index, AcronymsItem vAcronymsItem)
Enumeration	enumerateAcronymsItem() Method enumerateAcronymsItem
AcronymsItem[]	getAcronymsItem() Method getAcronymsItem
AcronymsItem	getAcronymsItem(int index) Method getAcronymsItem
int	getAcronymsItemCount() Method getAcronymsItemCount
boolean	isValid() Method isValid
Iterator	iterateAcronymsItem() Method iterateAcronymsItem
void	marshal(ContentHandler handler)
void	marshal(Writer out)
boolean	removeAcronymsItem(AcronymsItem vAcronymsItem) Method removeAcronymsItem
AcronymsItem	removeAcronymsItemAt(int index) Method removeAcronymsItemAt
void	removeAllAcronymsItem()
void	setAcronymsItem(AcronymsItem[] vAcronymsItemArray)
void	setAcronymsItem(int index, AcronymsItem vAcronymsItem)
static Acronyms	unmarshal(Reader reader) Method unmarshal
void	validate()

Methods inherited from class java.lang.Object

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

Constructor Detail

Acronyms

public Acronyms()

Method Detail

addAcronymsItem

public void addAcronymsItem(AcronymsItem vAcronymsItem)
                     throws IndexOutOfBoundsException

Parameters:

vAcronymsItem -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addAcronymsItem

public void addAcronymsItem(int index,
                            AcronymsItem vAcronymsItem)
                     throws IndexOutOfBoundsException

Parameters:

index -

vAcronymsItem -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

enumerateAcronymsItem

public Enumeration enumerateAcronymsItem()

Method enumerateAcronymsItem

Returns:

an Enumeration over all possible elements of this collection

getAcronymsItem

public AcronymsItem getAcronymsItem(int index)
                             throws IndexOutOfBoundsException

Method getAcronymsItem

Parameters:

index -

Returns:

the value of the textractor.acronyms.xml.AcronymsItem at the given index

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getAcronymsItem

public AcronymsItem[] getAcronymsItem()

Method getAcronymsItem

Returns:

this collection as an Array

getAcronymsItemCount

public int getAcronymsItemCount()

Method getAcronymsItemCount

Returns:

the size of this collection

isValid

public boolean isValid()

Method isValid

Returns:

true if this object is valid according to the schema

iterateAcronymsItem

public Iterator iterateAcronymsItem()

Method iterateAcronymsItem

Returns:

an Iterator over all possible elements in this collection

marshal

public void marshal(Writer out)
             throws MarshalException,
                    ValidationException

Parameters:

out -

Throws:

MarshalException - if object is null or if any SAXException is thrown during marshaling

ValidationException - if this object is an invalid instance according to the schema

marshal

public void marshal(ContentHandler handler)
             throws IOException,
                    MarshalException,
                    ValidationException

Parameters:

handler -

Throws:

IOException - if an IOException occurs during marshaling

ValidationException - if this object is an invalid instance according to the schema

MarshalException - if object is null or if any SAXException is thrown during marshaling

removeAcronymsItem

public boolean removeAcronymsItem(AcronymsItem vAcronymsItem)

Method removeAcronymsItem

Parameters:

vAcronymsItem -

Returns:

true if the object was removed from the collection.

removeAcronymsItemAt

public AcronymsItem removeAcronymsItemAt(int index)

Method removeAcronymsItemAt

Parameters:

index -

Returns:

the element removed from the collection

removeAllAcronymsItem

public void removeAllAcronymsItem()

setAcronymsItem

public void setAcronymsItem(int index,
                            AcronymsItem vAcronymsItem)
                     throws IndexOutOfBoundsException

Parameters:

index -

vAcronymsItem -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

setAcronymsItem

public void setAcronymsItem(AcronymsItem[] vAcronymsItemArray)

Parameters:

vAcronymsItemArray -

unmarshal

public static Acronyms unmarshal(Reader reader)
                          throws MarshalException,
                                 ValidationException

Method unmarshal

Parameters:

reader -

Returns:

the unmarshaled textractor.acronyms.xml.Acronyms

Throws:

MarshalException - if object is null or if any SAXException is thrown during marshaling

ValidationException - if this object is an invalid instance according to the schema

validate

public void validate()
              throws ValidationException

Throws:

ValidationException - if this object is an invalid instance according to the schema