com.ihr.xbrl.om

Class FastXMLFragmentContent<E extends XMLFragment>

java.lang.Object

com.ihr.xbrl.om.FastXMLFragmentContent<E>

Type Parameters:

E - the element type that must extends XMLFragment

public class FastXMLFragmentContent<E extends XMLFragment>
extends java.lang.Object

This class is a container of XMLFragments that can be used to speed-up operations performed inside the API such as adding a fact to an instance document while checking the fact is not already added to the instance document or adding a context to an instance document while checking the context is not already added to the instance document etc. The idea is to avoid calls to childExists(NodeImpl) on the XMLFragment.

Goals of this class are:

• Implement childExists(NodeImpl) using a HashSet or equivalent
• Provide fast implementation of getNew{...}Position()

If elements have specific order in the schema and makes sense to group similar elements all together it makes sense to create multiple "linked" instances of FastXMLFragmentContent. For instance, an Instance document contains DTS references, Facts, Contexts, Units, Footnotes and each one of them contains XMLFragments that are equivalent so it makes sense to create 5 instances of FastXMLFragmentContent inside the XBRLInstance class

Due to the reason methods that works with "children" member is final in the ParentNodeImpl class this class can't be automatically synchronized with the surrounding class

Author:

Ignacio

Constructor Summary

Constructors

Constructor and Description
FastXMLFragmentContent(XMLFragment parent, FastXMLFragmentContent<? extends XMLFragment> previous) Creates a new instance of a FastXMLFragmentContent
FastXMLFragmentContent(XMLFragment parent, FastXMLFragmentContent<? extends XMLFragment> previous, boolean bBatchMode) Creates a new instance of a FastXMLFragmentContent
FastXMLFragmentContent(XMLFragment parent, FastXMLFragmentContent<? extends XMLFragment> previous, boolean bBatchMode, java.lang.String addEventName, java.lang.String delEventName) Creates a new instance of a FastXMLFragmentContent
FastXMLFragmentContent(XMLFragment parent, FastXMLFragmentContent<? extends XMLFragment> previous, java.lang.String addEventName, java.lang.String delEventName) Creates a new instance of a FastXMLFragmentContent
FastXMLFragmentContent(XMLFragment parent, FastXMLFragmentContent<? super XMLFragment> previous, java.lang.Class<? extends XMLFragment>... classes) Creates a new instance of a FastXMLFragmentContent
FastXMLFragmentContent(XMLFragment parent, FastXMLFragmentContent<? super XMLFragment> previous, java.lang.String addEventName, java.lang.String delEventName, java.lang.Class<? extends XMLFragment>... classes) Creates a new instance of a FastXMLFragmentContent

Method Summary

Modifier and Type	Method and Description
void	add(E newChild) Adds the new child, Can only be called when newChild is not already a child of this node's parent.
void	add(E newChild, int position) adds a new child to this surrounding container at the indicated position.
void	addIndex(E newChild) This method adds a new child to the container but does not adds the child to the instance document.
void	addPropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener) Add a PropertyChangeListener for a specific property.
boolean	childExists(E newChild) Checks if this container already contains the node indicated in the newChild parameter.
void	clear() Clear all content.
boolean	equals(java.lang.Object obj) Equals.
java.util.Iterator<E>	getIterator() Gets the iterator.
java.util.Iterator<E>	getIterator(java.lang.Class<? extends XMLFragment> clazz) Gets the iterator.
FastXMLFragmentContent<? extends XMLFragment>	getPrevious() Obtains the previous FastXMLFragmentContent to this one.
int	hashCode() Hash code.
boolean	remove(E child) Removes the.
boolean	removeIndex(E child) Removes the.
void	removePropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener) Remove a PropertyChangeListener for a specific property.
int	size() Size.
int	size(java.lang.Class<? extends XMLFragment> clazz) Size.
java.lang.String	toString() To string.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FastXMLFragmentContent

@SafeVarargs
public FastXMLFragmentContent(XMLFragment parent,
                                           FastXMLFragmentContent<? super XMLFragment> previous,
                                           java.lang.Class<? extends XMLFragment>... classes)

Creates a new instance of a FastXMLFragmentContent

Parameters:

parent - the parent

previous - null if this is the first container

classes - this parameter allows this class to prepare internal accelerator classes to return the number of elements of specific sub classes. It is used in the XBRLExtendedLink because children might contain an unordered number of XBRLLocator, XBRLResource and XBRLRelationship/XBRLArc nodes but the implementation is generic enough to allow this class to be used for other purposes

FastXMLFragmentContent

@SafeVarargs
public FastXMLFragmentContent(XMLFragment parent,
                                           FastXMLFragmentContent<? super XMLFragment> previous,
                                           java.lang.String addEventName,
                                           java.lang.String delEventName,
                                           java.lang.Class<? extends XMLFragment>... classes)

Creates a new instance of a FastXMLFragmentContent

Parameters:

parent - the parent

previous - null if this is the first container

addEventName - the add event name

delEventName - the del event name

classes - this parameter allows this class to prepare internal accelerator classes to return the number of elements of specific sub classes. It is used in the XBRLExtendedLink because children might contain an unordered number of XBRLLocator, XBRLResource and XBRLRelationship/XBRLArc nodes but the implementation is generic enough to allow this class to be used for other purposes

FastXMLFragmentContent

public FastXMLFragmentContent(XMLFragment parent,
                              FastXMLFragmentContent<? extends XMLFragment> previous,
                              java.lang.String addEventName,
                              java.lang.String delEventName)

Creates a new instance of a FastXMLFragmentContent

Parameters:

parent - the parent

previous - null if this is the first container

addEventName - the add event name

delEventName - the del event name

FastXMLFragmentContent

public FastXMLFragmentContent(XMLFragment parent,
                              FastXMLFragmentContent<? extends XMLFragment> previous)

Creates a new instance of a FastXMLFragmentContent

Parameters:

parent - the parent

previous - null if this is the first container

FastXMLFragmentContent

public FastXMLFragmentContent(XMLFragment parent,
                              FastXMLFragmentContent<? extends XMLFragment> previous,
                              boolean bBatchMode)

Creates a new instance of a FastXMLFragmentContent

Parameters:

parent - the parent

previous - null if this is the first container

bBatchMode - the b batch mode

FastXMLFragmentContent

public FastXMLFragmentContent(XMLFragment parent,
                              FastXMLFragmentContent<? extends XMLFragment> previous,
                              boolean bBatchMode,
                              java.lang.String addEventName,
                              java.lang.String delEventName)

Creates a new instance of a FastXMLFragmentContent

Parameters:

parent - the parent

previous - null if this is the first container

bBatchMode - the b batch mode

addEventName - the add event name

delEventName - the del event name

Method Detail

getPrevious

public FastXMLFragmentContent<? extends XMLFragment> getPrevious()

Obtains the previous FastXMLFragmentContent to this one. The previous is set at construction time

Returns:

the previous

addPropertyChangeListener

public void addPropertyChangeListener(java.lang.String propertyName,
                                      java.beans.PropertyChangeListener listener)

Add a PropertyChangeListener for a specific property. The listener will be invoked only when a call on firePropertyChange names that specific property. The same listener object may be added more than once. For each property, the listener will be invoked the number of times it was added for that property. If propertyName or listener is null, no exception is thrown and no action is taken.

Parameters:

propertyName - The name of the property to listen on. see XBRLEvent

listener - The PropertyChangeListener to be added

removePropertyChangeListener

public void removePropertyChangeListener(java.lang.String propertyName,
                                         java.beans.PropertyChangeListener listener)

Remove a PropertyChangeListener for a specific property. If listener was added more than once to the same event source for the specified property, it will be notified one less time after being removed. If propertyName is null, no exception is thrown and no action is taken. If listener is null, or was never added for the specified property, no exception is thrown and no action is taken.

Parameters:

propertyName - The name of the property that was listened on.

listener - The PropertyChangeListener to be removed

add

public void add(E newChild)

Adds the new child, Can only be called when newChild is not already a child of this node's parent.

Parameters:

newChild - the new child

add

public void add(E newChild,
                int position)

adds a new child to this surrounding container at the indicated position. Note the position is indicated from the first child of the parent node, not from this FastXMLFragment container first node

Parameters:

newChild - the new child

position - the position

hashCode

public int hashCode()

Hash code.

Overrides:

hashCode in class java.lang.Object

Returns:

the int

equals

public boolean equals(java.lang.Object obj)

Equals.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the obj

Returns:

true, if successful

addIndex

public void addIndex(E newChild)

This method adds a new child to the container but does not adds the child to the instance document. It is used mainly during the readInfoset phase to populate existing objects

Parameters:

newChild - the new child

size

public int size()

Size.

Returns:

the int size

size

public int size(java.lang.Class<? extends XMLFragment> clazz)

Size.

Parameters:

clazz - the clazz

Returns:

the int

childExists

public boolean childExists(E newChild)

Checks if this container already contains the node indicated in the newChild parameter.

Parameters:

newChild - the new child

Returns:

true if the child already exists

clear

public void clear()

Clear all content.

removeIndex

public boolean removeIndex(E child)

Removes the.

Parameters:

child - the fact

Returns:

true, if successful

remove

public boolean remove(E child)

Removes the.

Parameters:

child - the child

Returns:

true, if successful

toString

public java.lang.String toString()

To string.

Overrides:

toString in class java.lang.Object

Returns:

the string

getIterator

public java.util.Iterator<E> getIterator()

Gets the iterator.

Returns:

the iterator

getIterator

public java.util.Iterator<E> getIterator(java.lang.Class<? extends XMLFragment> clazz)

Gets the iterator.

Parameters:

clazz - the clazz

Returns:

the iterator