LibreOffice Module xmerge (master) 1
Public Member Functions | Protected Member Functions | Static Private Attributes | List of all members
org.openoffice.xmerge.merger.diff.CellNodeIterator Class Reference

This is an implementations of the Iterator interface. More...

Inheritance diagram for org.openoffice.xmerge.merger.diff.CellNodeIterator:
[legend]
Collaboration diagram for org.openoffice.xmerge.merger.diff.CellNodeIterator:
[legend]

Public Member Functions

 CellNodeIterator (ConverterCapabilities cc, Node node)
 The standard constructor. More...
 
- Public Member Functions inherited from org.openoffice.xmerge.merger.diff.NodeIterator
 NodeIterator (ConverterCapabilities cc, Node node)
 Standard constructor. More...
 
Object next ()
 Move to next element in the sequence. More...
 
Object previous ()
 
Object start ()
 Move to the beginning of the sequence. More...
 
Object end ()
 
Object currentElement ()
 Return the current element Object content. More...
 
int elementCount ()
 Return the total element count in the sequence. More...
 
boolean equivalent (Object obj1, Object obj2)
 A method to allow the difference algorithm to test whether the obj1 and obj2 in the Iterator are considered equal. More...
 
void refresh ()
 A method to force the Iterator to traverse the tree again to refresh the content. More...
 
Object next ()
 Move to next element in the sequence. More...
 
Object start ()
 Move to the beginning of the sequence. More...
 
Object currentElement ()
 Return the current element Object content. More...
 
int elementCount ()
 Return the total element count in the sequence. More...
 
boolean equivalent (Object obj1, Object obj2)
 A method to allow the difference algorithm to test whether the obj1 and obj2 in the Iterator are considered equal. More...
 
void refresh ()
 A method to force the Iterator to traverse the tree again to refresh the content. More...
 

Protected Member Functions

boolean nodeSupported (Node node)
 Overwrite the parent nodeSupported method. More...
 
boolean childrenEqual (Node node1, Node node2)
 Compare the children of two Node objects. More...
 
- Protected Member Functions inherited from org.openoffice.xmerge.merger.diff.NodeIterator
boolean compareNode (Node node1, Node node2)
 Used to compare two Node objects (type/name/value) and all their children Node objects. More...
 
boolean childrenEqual (Node node1, Node node2)
 Compare the children of two Node objects. More...
 
abstract boolean nodeSupported (Node node)
 Check whether a Node is supported. More...
 

Static Private Attributes

static final String SUPPORTED_TAG1 = OfficeConstants.TAG_TABLE_CELL
 

Detailed Description

This is an implementations of the Iterator interface.

It will traverse the tree and find cell Node sequences.

Note: Once the XML Tree is parsed, then the Iterator will be a snapshot of that tree. That means even the tree is modified later, then the cached paragraph Node list will not be updated accordingly. For this reason and for performance reasons this Iterator does not support any operation methods such as insert, remove or replace. The main purpose of this Iterator is to be used with difference, not with merge.

Definition at line 39 of file CellNodeIterator.java.

Constructor & Destructor Documentation

◆ CellNodeIterator()

org.openoffice.xmerge.merger.diff.CellNodeIterator.CellNodeIterator ( ConverterCapabilities  cc,
Node  node 
)
inline

The standard constructor.

Parameters
ccThe ConverterCapabilities.
nodeThe initial root Node.

Definition at line 50 of file CellNodeIterator.java.

Member Function Documentation

◆ childrenEqual()

boolean org.openoffice.xmerge.merger.diff.CellNodeIterator.childrenEqual ( Node  node1,
Node  node2 
)
inlineprotected

Compare the children of two Node objects.

This method can be intentionally overridden by any class that extend from NodeIterator so that it can have its own children comparison if necessary.

Parameters
node1The first Node to compare.
node2The second Node to compare.
Returns
true if children are equal, false otherwise.

Reimplemented from org.openoffice.xmerge.merger.diff.NodeIterator.

Definition at line 74 of file CellNodeIterator.java.

References equal(), and org.openoffice.xmerge.converter.xml.OfficeConstants.TAG_PARAGRAPH.

◆ nodeSupported()

boolean org.openoffice.xmerge.merger.diff.CellNodeIterator.nodeSupported ( Node  node)
inlineprotected

Overwrite the parent nodeSupported method.

Only cell Node objects are supported.

Parameters
nodeThe Node to check.
Returns
true if the Node is supported, false otherwise.

Reimplemented from org.openoffice.xmerge.merger.diff.NodeIterator.

Definition at line 65 of file CellNodeIterator.java.

References org.openoffice.xmerge.merger.diff.CellNodeIterator.SUPPORTED_TAG1.

Member Data Documentation

◆ SUPPORTED_TAG1

final String org.openoffice.xmerge.merger.diff.CellNodeIterator.SUPPORTED_TAG1 = OfficeConstants.TAG_TABLE_CELL
staticprivate

The documentation for this class was generated from the following file: