net.sourceforge.nite.nom.nomwrite
Interface NOMPointer

All Known Implementing Classes:

NOMReadPointer, NOMWritePointer

public interface NOMPointer

Extends the nomread version with methods for editing pointers

Author:

jonathan

Nested Class Summary

static interface

NOMPointer.SharedPoint This inner interface provides a single utility function for shared NOM users - can be ignored if NOM is not shared amongst multiple applications that can write to the NOM.

Method Summary

java.lang.String	getComment() returns the contents of the reserved comment String (or null if not set)
NOMElement	getFromElement() returns the element which is the source of the pointer
java.lang.String	getLink() return a string representing an XLink to the pointed-to element
java.lang.String	getRole() returns the role of the pointer
NOMPointer.SharedPoint	getShared() return a shared view of this pointer which simply provides a single utility function for editing the pointer without thinking about locking and unlocking the corpus.
NOMElement	getToElement() returns the element which is the destination of the pointer
java.lang.String	getToElementString() returns the element which is the destination of the pointer as a string (the original href string from the loaded corpus)
void	setComment(java.lang.String comment) set the contents of the reserved comment attribute
void	setRole(java.lang.String role) set the role of this pointer
void	setToElement(NOMElement target) set the element to which this pointer points

Method Detail

getRole

java.lang.String getRole()

returns the role of the pointer

getFromElement

NOMElement getFromElement()

returns the element which is the source of the pointer

getToElement

NOMElement getToElement()

returns the element which is the destination of the pointer

getToElementString

java.lang.String getToElementString()

returns the element which is the destination of the pointer as a string (the original href string from the loaded corpus)

getComment

java.lang.String getComment()

returns the contents of the reserved comment String (or null if not set)

getLink

java.lang.String getLink()

return a string representing an XLink to the pointed-to element

setRole

void setRole(java.lang.String role)

set the role of this pointer

setToElement

void setToElement(NOMElement target)
                  throws NOMException

set the element to which this pointer points

Throws:

NOMException

getShared

NOMPointer.SharedPoint getShared()

return a shared view of this pointer which simply provides a single utility function for editing the pointer without thinking about locking and unlocking the corpus.

setComment

void setComment(java.lang.String comment)

set the contents of the reserved comment attribute