com.ximpleware.extended
Class BookMarkHuge

java.lang.Object
  com.ximpleware.extended.BookMarkHuge

public class BookMarkHuge
extends Object

BookmarkHue is a single instance of a node position. You can save the cursor's position into a BookMarkHuge instance You can also point the cursor to the node position of previously saved BookMarkHuge instance.

Constructor Summary

BookMarkHuge()
Constructor for BookMarkHuge Take no argument

BookMarkHuge(VTDNavHuge vn)
BookMarkHuge constructor with an instance of vn as input

Method Summary

void	bind(VTDNavHuge vn) bind a BookMarkHuge object to a VTDNavHuge object the cursor position is set to an invalid state
boolean	compare(BookMarkHuge bm1) Compare the node positions of two bookMarkHuge objects
boolean	deepEquals(BookMarkHuge bm2) Compare the bookmarks to ensure they represent the same node in the same VTDNavHuge instance
boolean	equals(BookMarkHuge bm2) Compare the bookmarks to ensure they represent the same node in the same VTDNavHuge instance
boolean	equals(Object obj) Compare two bookmarks to ensure they represent the same node in the same VTDNavHuge instance
VTDNavHuge	getNav() This method returns the embedded VTDNavHuge Object
int	hashCode() Returns the hash code which is a unique integer for every node
boolean	recordCursorPosition() Record cursor position of the VTDNavHuge object as embedded in the bookmark
boolean	recordCursorPosition(VTDNavHuge vn) Record the cursor position This method is implemented to be lenient on loading in that it can load nodes from any VTDNavHuge object if vn is null, return false
boolean	setCursorPosition() Set the cursor position of VTDNavHuge object corresponding to the internal reference position of the embedded VTDNavHuge object
boolean	setCursorPosition(VTDNavHuge vn) set cursor position This method can only set the cursor position of an VTDNavHuge object identical to its internal copy
void	unbind() separate a bookMark object apart from its embedded VTDNavHuge instance

Methods inherited from class java.lang.Object

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

Constructor Detail

BookMarkHuge

public BookMarkHuge()

Constructor for BookMarkHuge Take no argument

BookMarkHuge

public BookMarkHuge(VTDNavHuge vn)

BookMarkHuge constructor with an instance of vn as input

Parameters:

vn -

Method Detail

unbind

public void unbind()

separate a bookMark object apart from its embedded VTDNavHuge instance

bind

public void bind(VTDNavHuge vn)

bind a BookMarkHuge object to a VTDNavHuge object the cursor position is set to an invalid state

Parameters:

vn -

getNav

public VTDNavHuge getNav()

This method returns the embedded VTDNavHuge Object

Returns:

VTDNavHuge

setCursorPosition

public boolean setCursorPosition(VTDNavHuge vn)

set cursor position This method can only set the cursor position of an VTDNavHuge object identical to its internal copy

Parameters:

vn -

Returns:

setCursorPosition

public boolean setCursorPosition()

Set the cursor position of VTDNavHuge object corresponding to the internal reference position of the embedded VTDNavHuge object

Returns:

recordCursorPosition

public boolean recordCursorPosition(VTDNavHuge vn)

Record the cursor position This method is implemented to be lenient on loading in that it can load nodes from any VTDNavHuge object if vn is null, return false

Parameters:

vn -

Returns:

recordCursorPosition

public boolean recordCursorPosition()

Record cursor position of the VTDNavHuge object as embedded in the bookmark

Returns:

deepEquals

public final boolean deepEquals(BookMarkHuge bm2)

Compare the bookmarks to ensure they represent the same node in the same VTDNavHuge instance

Parameters:

bm2 -

Returns:

equals

public final boolean equals(BookMarkHuge bm2)

Compare the bookmarks to ensure they represent the same node in the same VTDNavHuge instance

Parameters:

bm2 -

Returns:

equals

public final boolean equals(Object obj)

Compare two bookmarks to ensure they represent the same node in the same VTDNavHuge instance

Overrides:

equals in class Object

hashCode

public final int hashCode()

Returns the hash code which is a unique integer for every node

Overrides:

hashCode in class Object

compare

public boolean compare(BookMarkHuge bm1)

Compare the node positions of two bookMarkHuge objects

Parameters:

bm1 -

Returns: