com.ibm.xsp.model.domino.wrapped
Class AbstractDominoViewEntry

java.lang.Object
  com.ibm.xsp.model.domino.wrapped.AbstractDominoViewEntry

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, lotus.domino.Base, lotus.domino.ViewEntry

Direct Known Subclasses:

DominoViewEntry

public abstract class AbstractDominoViewEntry
extends java.lang.Object
implements java.io.Externalizable, lotus.domino.ViewEntry

Extended ViewEntry with extra methods.

See Also:

Serialized Form

Field Summary

protected lotus.domino.ViewEntry	_wrappedObject
protected java.util.Vector	javaColumnValues
protected java.util.Vector	notesColumnValues
static int	VC_NOT_PRESENT

Fields inherited from interface lotus.domino.ViewEntry

TYPE_CATEGORY, TYPE_DOCUMENT, TYPE_TOTAL

Constructor Summary

	AbstractDominoViewEntry() Default constructor - for Serialization only
protected	AbstractDominoViewEntry(lotus.domino.ViewEntry _wrappedObject) Constructor that takes a ViewEntry to be wrapped

Method Summary

void	clearTransientValues() Clear the transient values (the Notes format one).
void	clearValues() Clear the cached values.
int	getChildCount() Return the number of immediate children belonging to the current view entry
int	getColumnIndentLevel() The indent level of a view entry within its column.
abstract java.lang.Object	getColumnValue(java.lang.String name) XPages extended API. Return the value for the specified column name from the View Entry
java.util.Vector	getColumnValues() Returns the value of each column in the view entry.
protected lotus.domino.Database	getDatabase() Return the Database contain the View this View Entry comes from.
java.lang.String	getDatabaseName() Return the name of Database contain the View this View Entry comes from.
int	getDescendantCount() The number of descendants belonging to the current view entry.
lotus.domino.Document	getDocument() The document associated with the view entry.
int	getFTSearchScore() The full-text search score of a view entry, if it was retrieved as part of a full-text search.
java.lang.String	getId() Deprecated.
int	getIndentLevel() The indent level of a view entry within the view.
java.util.Vector	getJavaColumnValues() Returns the value of each column in the view entry using Java type.
java.lang.String	getNavigatorPosition() XPages extended API. Get the position of the ViewEntry using '.' as the character separator.
java.lang.String	getNoteID() The note ID of a view entry of type document.
int	getNoteIDAsInt()
java.lang.String	getOpenPageURL(java.lang.String pageName, boolean readOnly) XPages extended API. Get the URL of the page to open when a View Entry is selected
java.lang.Object	getParent() Return the parent ViewEntryCollection, ViewNavigator, or View object of a view entry.
java.lang.String	getPosition() XPages extended API. Get the position of the ViewEntry using '.' as the character separator.
java.lang.String	getPosition(char arg0) Returns the position of the entry in the view hierarchy, for example, "2.3" for the third document of the second category.
boolean	getRead() Returns true if the current entry has been read, otherwise false.
boolean	getRead(java.lang.String arg0) Returns true if the current entry has been read, otherwise false.
int	getResponseCount() Deprecated.
int	getResponseLevel() Deprecated.
int	getSiblingCount() The number of siblings belonging to the current view entry (Read Only).
protected java.lang.String	getTarget(boolean readOnly)
java.lang.String	getUniversalID() The universal ID of a document associated with a view entry.
protected lotus.domino.View	getView() Return the View this View Entry is part of.
protected lotus.domino.ViewEntry	getViewEntry() Returned the wrapped ViewEntry
boolean	isCategory() Indicates whether a view entry is a category.
boolean	isConflict() Indicates whether a view entry is for a document on which a replication or save conflict occurred.
boolean	isDocument() Indicates whether a view entry is a document.
boolean	isExpanded() XPages extended API. Return true if the ViewEntry is expanded Returns false.
boolean	isPreferJavaDates() Return whether the View Entry will return Java Dates.
boolean	isSelected() XPages extended API. Simply return false.
boolean	isTotal() Indicates whether a view entry is a total.
boolean	isValid() Indicates whether a view entry is a valid entry and not a deletion stub.
void	readExternal(java.io.ObjectInput in)
void	recycle() The recycle method unconditionally destroys an object and returns its memory to the system.
void	recycle(java.util.Vector arg0) The recycle method unconditionally destroys an object and returns its memory to the system.
void	setExpanded(boolean expanded) XPages extended API. Set the state of whether the ViewEntry is expanded or not Empty method that should be overridden
void	setPreferJavaDates(boolean javaDate) Set whether the View Entry will return Java Dates.
void	setSelected(boolean selected) XPages extended API. Empty method.
void	toggleExpanded() XPages extended API. Empty methoid that should be overridden
java.lang.String	toString() XPages extended API. Return the list of Java Column Values as a String
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

VC_NOT_PRESENT

public static final int VC_NOT_PRESENT

See Also:

Constant Field Values

_wrappedObject

protected transient lotus.domino.ViewEntry _wrappedObject

notesColumnValues

protected transient java.util.Vector notesColumnValues

javaColumnValues

protected java.util.Vector javaColumnValues

Constructor Detail

AbstractDominoViewEntry

public AbstractDominoViewEntry()

Default constructor - for Serialization only

AbstractDominoViewEntry

protected AbstractDominoViewEntry(lotus.domino.ViewEntry _wrappedObject)
                           throws lotus.domino.NotesException

Constructor that takes a ViewEntry to be wrapped

Parameters:

_wrappedObject -

Throws:

lotus.domino.NotesException

Method Detail

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException

getView

protected lotus.domino.View getView()
                             throws lotus.domino.NotesException

Return the View this View Entry is part of. View Entry -> View or -> View Navigator -> View

Returns:

Return the View this View Entry is part of.

Throws:

lotus.domino.NotesException

getDatabase

protected lotus.domino.Database getDatabase()
                                     throws lotus.domino.NotesException

Return the Database contain the View this View Entry comes from.

Returns:

Return the Database contain the View this View Entry comes from.

Throws:

lotus.domino.NotesException

getDatabaseName

public java.lang.String getDatabaseName()
                                 throws lotus.domino.NotesException

Return the name of Database contain the View this View Entry comes from. If Database is remote - then name is !!

Returns:

Return the name of Database contain the View this View Entry comes from.

Throws:

lotus.domino.NotesException

getViewEntry

protected lotus.domino.ViewEntry getViewEntry()

Returned the wrapped ViewEntry

Returns:

Returned the wrapped ViewEntry

clearValues

public void clearValues()

Clear the cached values. All the values are removed, including the transient and non transient one.

clearTransientValues

public void clearTransientValues()

Clear the transient values (the Notes format one). In most of the cases, this Vector is null. It has a value only if a user tries to get all the values explicitly from custom code.

getChildCount

public int getChildCount()
                  throws lotus.domino.NotesException

Return the number of immediate children belonging to the current view entry

Specified by:

getChildCount in interface lotus.domino.ViewEntry

Throws:

lotus.domino.NotesException

getColumnIndentLevel

public int getColumnIndentLevel()
                         throws lotus.domino.NotesException

The indent level of a view entry within its column. This property is useful for determining the response level of a document. Main documents are always at indent level 0, response documents at indent level 1, and so on.

Specified by:

getColumnIndentLevel in interface lotus.domino.ViewEntry

Throws:

lotus.domino.NotesException

getColumnValues

public java.util.Vector getColumnValues()
                                 throws lotus.domino.NotesException

Returns the value of each column in the view entry. Type java.util.Vector; elements are Double, DateTime, or String

Specified by:

getColumnValues in interface lotus.domino.ViewEntry

Throws:

lotus.domino.NotesException

getJavaColumnValues

public java.util.Vector getJavaColumnValues()
                                     throws lotus.domino.NotesException

Returns the value of each column in the view entry using Java type.

Throws:

lotus.domino.NotesException

getDescendantCount

public int getDescendantCount()
                       throws lotus.domino.NotesException

The number of descendants belonging to the current view entry.

Specified by:

getDescendantCount in interface lotus.domino.ViewEntry

Throws:

lotus.domino.NotesException

getDocument

public lotus.domino.Document getDocument()
                                  throws lotus.domino.NotesException

The document associated with the view entry. Returns null if the view entry is not a document. Returns null if the document is deleted after the ViewEntry object is created.

Specified by:

getDocument in interface lotus.domino.ViewEntry

Throws:

lotus.domino.NotesException

getFTSearchScore

public int getFTSearchScore()
                     throws lotus.domino.NotesException

The full-text search score of a view entry, if it was retrieved as part of a full-text search. The score is determined by the number of target words that are found in the entry, the term weights assigned to the target words, and any proximity operators in the search query. If the entries are not retrieved as part of a full-text search, returns 0. If the entry is retrieved using an FTSearch method on a database without a full-text index, returns an unpredictable number.

Specified by:

getFTSearchScore in interface lotus.domino.ViewEntry

Throws:

lotus.domino.NotesException

getIndentLevel

public int getIndentLevel()
                   throws lotus.domino.NotesException

The indent level of a view entry within the view. The indent level corresponds to the number of levels in the position. Position 1 is indent level 0, position 1.1 is indent level 1, position 1.1.1 is indent level 2, and so on.

Specified by:

getIndentLevel in interface lotus.domino.ViewEntry

Throws:

lotus.domino.NotesException

getNoteID

public java.lang.String getNoteID()
                           throws lotus.domino.NotesException

The note ID of a view entry of type document. This property returns the empty string for entries of type category and total.

Specified by:

getNoteID in interface lotus.domino.ViewEntry

Throws:

lotus.domino.NotesException

getParent

public java.lang.Object getParent()
                           throws lotus.domino.NotesException

Return the parent ViewEntryCollection, ViewNavigator, or View object of a view entry.

Specified by:

getParent in interface lotus.domino.ViewEntry

Returns:

The parent ViewEntryCollection, ViewNavigator, or View object of a view entry.

Throws:

lotus.domino.NotesException

getPosition

public java.lang.String getPosition(char arg0)
                             throws lotus.domino.NotesException

Returns the position of the entry in the view hierarchy, for example, "2.3" for the third document of the second category.

Specified by:

getPosition in interface lotus.domino.ViewEntry

Returns:

A series of integers (in String format) and separators. The integers indicate the positions of the view entry at each level, where 1 is the first position. The first integer indicates the first level and so on.

Throws:

lotus.domino.NotesException

getRead

public boolean getRead()
                throws lotus.domino.NotesException

Returns true if the current entry has been read, otherwise false.

Specified by:

getRead in interface lotus.domino.ViewEntry

Throws:

lotus.domino.NotesException

See Also:

ViewEntry.getRead()

getRead

public boolean getRead(java.lang.String arg0)
                throws lotus.domino.NotesException

Returns true if the current entry has been read, otherwise false.

Specified by:

getRead in interface lotus.domino.ViewEntry

Parameters:

arg0 - If supplied, the username who has or has not read the entry. Otherwise, defaults to the name of the current user.

Returns:

True if the current entry has been read by username. False if it has not been read by username.

Throws:

lotus.domino.NotesException

See Also:

ViewEntry.getRead(java.lang.String)

getSiblingCount

public int getSiblingCount()
                    throws lotus.domino.NotesException

The number of siblings belonging to the current view entry (Read Only).

Specified by:

getSiblingCount in interface lotus.domino.ViewEntry

Throws:

lotus.domino.NotesException

See Also:

ViewEntry.getSiblingCount()

getUniversalID

public java.lang.String getUniversalID()
                                throws lotus.domino.NotesException

The universal ID of a document associated with a view entry. The ID is a 32-character combination of hexadecimal digits (0-9, A-F) that uniquely identifies a document across all replicas of a database.

Specified by:

getUniversalID in interface lotus.domino.ViewEntry

Throws:

lotus.domino.NotesException

See Also:

ViewEntry.getUniversalID()

isCategory

public boolean isCategory()
                   throws lotus.domino.NotesException

Indicates whether a view entry is a category.

Specified by:

isCategory in interface lotus.domino.ViewEntry

Throws:

lotus.domino.NotesException

See Also:

ViewEntry.isCategory()

isConflict

public boolean isConflict()
                   throws lotus.domino.NotesException

Indicates whether a view entry is for a document on which a replication or save conflict occurred.

Specified by:

isConflict in interface lotus.domino.ViewEntry

Throws:

lotus.domino.NotesException

See Also:

ViewEntry.isConflict()

isDocument

public boolean isDocument()
                   throws lotus.domino.NotesException

Indicates whether a view entry is a document.

Specified by:

isDocument in interface lotus.domino.ViewEntry

Throws:

lotus.domino.NotesException

See Also:

ViewEntry.isDocument()

isTotal

public boolean isTotal()
                throws lotus.domino.NotesException

Indicates whether a view entry is a total.

Specified by:

isTotal in interface lotus.domino.ViewEntry

Throws:

lotus.domino.NotesException

See Also:

ViewEntry.isTotal()

isPreferJavaDates

public boolean isPreferJavaDates()
                          throws lotus.domino.NotesException

Return whether the View Entry will return Java Dates.

Specified by:

isPreferJavaDates in interface lotus.domino.ViewEntry

Throws:

lotus.domino.NotesException

See Also:

ViewEntry.isPreferJavaDates()

setPreferJavaDates

public void setPreferJavaDates(boolean javaDate)
                        throws lotus.domino.NotesException

Set whether the View Entry will return Java Dates.

Specified by:

setPreferJavaDates in interface lotus.domino.ViewEntry

Throws:

lotus.domino.NotesException

See Also:

ViewEntry.setPreferJavaDates(boolean)

isValid

public boolean isValid()
                throws lotus.domino.NotesException

Indicates whether a view entry is a valid entry and not a deletion stub.

Specified by:

isValid in interface lotus.domino.ViewEntry

Throws:

lotus.domino.NotesException

See Also:

ViewEntry.isValid()

recycle

public void recycle()
             throws lotus.domino.NotesException

The recycle method unconditionally destroys an object and returns its memory to the system. Java has no knowledge of the heavyweight back-end Domino Objects, only the lightweight Java objects representing them. Garbage collection has no effect on Domino Objects unless you first explicitly recycle them.

Specified by:

recycle in interface lotus.domino.Base

Throws:

lotus.domino.NotesException

See Also:

Base.recycle()

recycle

public void recycle(java.util.Vector arg0)
             throws lotus.domino.NotesException

The recycle method unconditionally destroys an object and returns its memory to the system. The vector contains the Domino Objects to be recycled. This method effectively batches recycle operations and is especially efficient for remote (IIOP) calls. Java has no knowledge of the heavyweight back-end Domino Objects, only the lightweight Java objects representing them. Garbage collection has no effect on Domino Objects unless you first explicitly recycle them.

Specified by:

recycle in interface lotus.domino.Base

Throws:

lotus.domino.NotesException

See Also:

Base.recycle(java.util.Vector)

getNoteIDAsInt

public int getNoteIDAsInt()
                   throws lotus.domino.NotesException

Specified by:

getNoteIDAsInt in interface lotus.domino.ViewEntry

Throws:

lotus.domino.NotesException

See Also:

lotus.domino.Base#getNoteIDAsInt(java.util.Vector)

getColumnValue

public abstract java.lang.Object getColumnValue(java.lang.String name)

XPages extended API. Return the value for the specified column name from the View Entry

getOpenPageURL

public java.lang.String getOpenPageURL(java.lang.String pageName,
                                       boolean readOnly)

XPages extended API. Get the URL of the page to open when a View Entry is selected

getTarget

protected java.lang.String getTarget(boolean readOnly)

toString

public java.lang.String toString()

XPages extended API. Return the list of Java Column Values as a String

Overrides:

toString in class java.lang.Object

getNavigatorPosition

public java.lang.String getNavigatorPosition()
                                      throws lotus.domino.NotesException

XPages extended API. Get the position of the ViewEntry using '.' as the character separator. See getPosition(char)

Throws:

lotus.domino.NotesException

getPosition

public java.lang.String getPosition()
                             throws lotus.domino.NotesException

XPages extended API. Get the position of the ViewEntry using '.' as the character separator. See getPosition(char)

Throws:

lotus.domino.NotesException

isSelected

public boolean isSelected()

XPages extended API. Simply return false. Should be overridden.

setSelected

public void setSelected(boolean selected)

XPages extended API. Empty method. Should be overridden.

isExpanded

public boolean isExpanded()

XPages extended API. Return true if the ViewEntry is expanded Returns false. Should be overridden.

setExpanded

public void setExpanded(boolean expanded)

XPages extended API. Set the state of whether the ViewEntry is expanded or not Empty method that should be overridden

toggleExpanded

public void toggleExpanded()

XPages extended API. Empty methoid that should be overridden

getResponseCount

public int getResponseCount()
                     throws lotus.domino.NotesException

Deprecated.

The number of immediate children belonging to the current view entry.

Throws:

lotus.domino.NotesException

getResponseLevel

public int getResponseLevel()
                     throws lotus.domino.NotesException

Deprecated.

The indent level of a view entry within its column.

Throws:

lotus.domino.NotesException

getId

public java.lang.String getId()

Deprecated.

The note ID of a view entry of type document.