com.ihr.xbrl.mapper

Interface HasMapperFacts

All Known Implementing Classes:

MapperFact, MapperFacts

public interface HasMapperFacts

This interface is implemented by the Mapper and the Fact classes Both are able to provide a collection of children facts.

Author:

Ignacio

Method Summary

Modifier and Type	Method and Description
void	addChildToIndex(MapperFact e) Called during the SAX parse process to add child to factsContent
void	addFact(MapperFact newFact) Adds a new Fact to the end of the Facts container.
void	addFactAt(MapperFact newFact, int pos) Adds a new Fact at the position indicated by pos.
void	delFact(MapperFact fact) Removes a fact from the container.
boolean	equals(java.lang.Object obj) Equals.
java.util.Iterator<MapperFact>	getChildrenFacts() Access to an iterator over the children facts of this object.
int	getChildrenFactsCount() Returns the number of facts.
HasMapperFacts	getMapperParent() Access to the parent element of a Fact.
int	hashCode() Hash code.
void	registerFact(MapperFact fact) Registers a new fact has been added to the container.
void	unregisterFact(MapperFact fact) Same as registerFact(MapperFact) but in this case for removing the information stored.

Method Detail

getChildrenFacts

java.util.Iterator<MapperFact> getChildrenFacts()

Access to an iterator over the children facts of this object.

Returns:

Iterator over children facts

getChildrenFactsCount

int getChildrenFactsCount()

Returns the number of facts.

Returns:

the children facts count

getMapperParent

HasMapperFacts getMapperParent()

Access to the parent element of a Fact. This is null only when the current HasMapperFacts is a template document

Returns:

MapperFact that represents a tupleFact or templateDocument. Null when current HasMapperFacts object is the template.

addFact

void addFact(MapperFact newFact)
      throws MapConfigurationFileException

Adds a new Fact to the end of the Facts container.

This method does not updates the taxonomy URLs.

Parameters:

newFact - the new fact to be added

Throws:

MapConfigurationFileException - the map configuration file exception

addFactAt

void addFactAt(MapperFact newFact,
               int pos)
        throws MapConfigurationFileException

Adds a new Fact at the position indicated by pos.

Parameters:

newFact - Fact to be added

pos - integer. Zero based

Throws:

MapConfigurationFileException - the map configuration file exception

delFact

void delFact(MapperFact fact)

Removes a fact from the container.

Parameters:

fact - Fact to remove

registerFact

void registerFact(MapperFact fact)
           throws MapConfigurationFileException

Registers a new fact has been added to the container. This method updates the Hashtables in the instance template and passes UP to its parent the registration of facts for tuples. This method is called internally by the API and should not be called manually

Parameters:

fact - the fact

Throws:

MapConfigurationFileException - the map configuration file exception

unregisterFact

void unregisterFact(MapperFact fact)

Same as registerFact(MapperFact) but in this case for removing the information stored.

Parameters:

fact - the fact

hashCode

int hashCode()

Hash code.

Overrides:

hashCode in class java.lang.Object

Returns:

the int

equals

boolean equals(java.lang.Object obj)

Equals.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the obj

Returns:

true, if successful

addChildToIndex

void addChildToIndex(MapperFact e)

Called during the SAX parse process to add child to factsContent

Parameters:

e -