Package eu.bandm.tools.dtd

Class ElementIndex

java.lang.Object

eu.bandm.tools.dtd.ElementIndex

public class ElementIndex
extends Object

Maintains for one given DTD.Dtd an index from element names into DTD.Elements. Generates an error in case of doubly used element names.

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,DTD.Element>	name2element
protected Map<String,Integer>	name2elementindex
protected DTD.Dtd	source

Constructor Summary

Constructors

Constructor	Description
ElementIndex()

Method Summary

Modifier and Type	Method	Description
Set<String>	allElementNames()	Returns all names(/"tags") used for DTD.Elements in the dtd.
Collection<DTD.Element>	allElements()	Returns all DTD.Element objects in the dtd.
DTD.Element	getElement(String name)	Return the DTD.Element object for a given element name ("tag").
int	getIndex(String name)	Returns an integer index for a given element name ("tag").
DTD.Dtd	getSource()	Returns the DTD.Dtd which this object reflects.
void	update(MessageReceiver<? super SimpleMessage<XMLDocumentIdentifier>> msg, DTD.Dtd dtd)	Must be called exactly once to initialize maps with a certain dtd.

Methods inherited from class java.lang.Object

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

Field Details

name2element

protected Map<String,DTD.Element> name2element

name2elementindex

protected Map<String,Integer> name2elementindex

source

protected DTD.Dtd source

Constructor Details

ElementIndex

public ElementIndex()

Method Details

update

public void update(MessageReceiver<? super SimpleMessage<XMLDocumentIdentifier>> msg,
 DTD.Dtd dtd)

Must be called exactly once to initialize maps with a certain dtd. Sends to the message channel error messages in case of duplicate usage of element names.

Throws:

IllegalStateException - if called more than once.

getIndex

public int getIndex(String name)

Returns an integer index for a given element name ("tag"). The indexes correspond to the sequential order in the original dtd.

Throws:

IllegalStateException - in case update(MessageReceiver,DTD.Dtd) has not been called before.

getElement

public DTD.Element getElement(String name)

Return the DTD.Element object for a given element name ("tag").

Throws:

IllegalStateException - in case update(MessageReceiver,DTD.Dtd) has not been called before.

allElements

public Collection<DTD.Element> allElements()

Returns all DTD.Element objects in the dtd.

Throws:

IllegalStateException - in case update(MessageReceiver,DTD.Dtd) has not been called before.

allElementNames

public Set<String> allElementNames()

Returns all names(/"tags") used for DTD.Elements in the dtd.

Throws:

IllegalStateException - in case update(MessageReceiver,DTD.Dtd) has not been called before.

getSource

public DTD.Dtd getSource()

Returns the DTD.Dtd which this object reflects.