de.bea.domingo.proxy
Class ViewProxy

java.lang.Object
  de.bea.domingo.monitor.AbstractMonitorEnabled
      de.bea.domingo.proxy.BaseProxy
          de.bea.domingo.proxy.BaseCollectionProxy
              de.bea.domingo.proxy.ViewProxy

All Implemented Interfaces:

DBase, DView, MonitorEnabled, java.io.Serializable

public final class ViewProxy
extends BaseCollectionProxy
implements DView

Represents the Domino-Class View.

Author:

Kurt Riede

See Also:

Serialized Form

Nested Class Summary

class	ViewProxy.CategoryIterator A CategoriesIterator allows iteration over a set of lotus.domino.ViewEntrys that are categories.
class	ViewProxy.ViewEntriesIterator A ViewEntriesIterator allows iteration over a set of lotus.domino.ViewEntrys in view order.
class	ViewProxy.ViewEntriesReverseIterator A ViewEntriesIterator allows iteration over a set of lotus.domino.ViewEntrys in reverse order.
class	ViewProxy.ViewNavigatorIterator Uses a ViewNavigator to iterate over all entries in a view, starting with a given entry.

Nested classes/interfaces inherited from class de.bea.domingo.proxy.BaseCollectionProxy

BaseCollectionProxy.ViewIterator

Nested classes/interfaces inherited from class de.bea.domingo.proxy.BaseProxy

BaseProxy.DocumentCollectionIterator

Field Summary

Fields inherited from class de.bea.domingo.proxy.BaseProxy

DATETIME_STRING_LENGTH, EMPTY_STRING, MAX_DATETIME_LENGTH, NUM_DATETIME_VALUES, RESOURCES

Method Summary

void	clear() Clears the full-text search filtering on a view.
int	fullTextSearch(java.lang.String query) Conducts a full-text search on all documents in a view and filters the view so it represents only those documents that match the full-text query.
int	fullTextSearch(java.lang.String query, int maxdocs) Conducts a full-text search on all documents in a view and filters the view so it represents only those documents that match the full-text query.
java.util.Iterator	getAllCategories() Finds view entries of type category.
java.util.Iterator	getAllCategories(int level) Finds view entries of type category upto a given level.
java.util.Iterator	getAllCategoriesByKey(java.util.List key) Deprecated.
java.util.Iterator	getAllCategoriesByKey(java.util.List key, boolean exact) Deprecated.
java.util.Iterator	getAllCategoriesByKey(java.util.List key, int level) Deprecated.
java.util.Iterator	getAllCategoriesByKey(java.util.List key, int level, boolean exact) Deprecated.
java.util.Iterator	getAllCategoriesByKey(java.lang.String key) Deprecated.
java.util.Iterator	getAllCategoriesByKey(java.lang.String key, boolean exact) Deprecated.
java.util.Iterator	getAllCategoriesByKey(java.lang.String key, int level) Deprecated.
java.util.Iterator	getAllCategoriesByKey(java.lang.String key, int level, boolean exact) Deprecated.
java.util.Iterator	getAllDocuments() Returns an Iterator to loop over all documents in the view.
java.util.Iterator	getAllDocumentsByKey(java.util.Calendar key) Finds documents based on their column values within a view.
java.util.Iterator	getAllDocumentsByKey(java.util.Calendar key, boolean exact) Finds documents based on their column values within a view.
java.util.Iterator	getAllDocumentsByKey(double key) Finds documents based on their column values within a view.
java.util.Iterator	getAllDocumentsByKey(double key, boolean exact) Finds documents based on their column values within a view.
java.util.Iterator	getAllDocumentsByKey(int key) Finds documents based on their column values within a view.
java.util.Iterator	getAllDocumentsByKey(int key, boolean exact) Finds documents based on their column values within a view.
java.util.Iterator	getAllDocumentsByKey(java.util.List keys) Finds documents based on their column values within a view.
java.util.Iterator	getAllDocumentsByKey(java.util.List keys, boolean exact) Finds documents based on their column values within a view.
java.util.Iterator	getAllDocumentsByKey(java.lang.String key) Finds documents based on their column values within a view.
java.util.Iterator	getAllDocumentsByKey(java.lang.String key, boolean exact) Finds documents based on their column values within a view.
java.util.Iterator	getAllEntries() Iterator over all entries in a view in view order.
java.util.Iterator	getAllEntries(DViewEntry entry) Iterator over all entries in a view in view order starting with a given entry.
java.util.Iterator	getAllEntriesByKey(java.util.Calendar start, java.util.Calendar end, boolean exact) Finds view entries of type document based on their column values within a view.
java.util.Iterator	getAllEntriesByKey(java.util.List keys) Finds view entries of type document based on their column values within a view.
java.util.Iterator	getAllEntriesByKey(java.util.List keys, boolean exact) Finds view entries of type document based on their column values within a view.
java.util.Iterator	getAllEntriesByKey(java.lang.String key) Finds view entries of type document based on their column values within a view.
java.util.Iterator	getAllEntriesByKey(java.lang.String key, boolean exact) Finds view entries of type document based on their column values within a view.
java.util.Iterator	getAllEntriesReverse() Iterator over all entries in a view in reverse view order.
DViewColumn	getColumn(int i) Returns a specified column in a view.
int	getColumnCount() Returns the number of columns in a view.
java.util.List	getColumnNames() Retutrns the names of the columns in a view.
java.util.List	getColumns() Returns the columns in a view.
DDocument	getDocumentByKey(java.util.List keys, boolean exact) Finds a document based on its column values within a view.
DDocument	getDocumentByKey(java.lang.String key, boolean exact) Finds a document based on the first column value within a view.
(package private) ViewEntryProxy	getDViewEntry(DBase parent, lotus.domino.ViewEntry viewEntry) Creates and returns a Proxy for a ViewEntry.
DViewEntry	getEntryByKey(java.util.List keys) Finds a view entry based on its column values within a view.
DViewEntry	getEntryByKey(java.util.List keys, boolean exact) Finds a view entry based on its column values within a view.
DViewEntry	getEntryByKey(java.lang.String key) Finds a view entry based on its column values within a view.
DViewEntry	getEntryByKey(java.lang.String key, boolean exact) Finds a view entry based on its column values within a view.
(package private) static ViewProxy	getInstance(NotesProxyFactory theFactory, DDatabase database, lotus.domino.View view, DNotesMonitor monitor) Returns a view object.
java.lang.String	getName() Returns the name of a view.
java.lang.String	getSelectionFormula() Returns the selection formula of a view.
void	refresh() Updates view contents with any changes that have occurred to the database since the View object was created, or since the last refresh.
void	setSelectionFormula(java.lang.String formula) Sets the selection formula of a view.
java.lang.String	toString() Returns a short description of an instance.

Methods inherited from class de.bea.domingo.proxy.BaseProxy

checkSession, clearNotesObject, convertCalendarsToNotesDateTime, convertListToVector, convertNotesDateTimesToCalendar, convertVectorToList, createCalendar, createDateRange, createDateTime, decrementDateTimeCounter, finalize, getCountDateTime, getDSession, getFactory, getNotesObject, getParent, incrementDateTimeCounter, newException, newException, newException, newRuntimeException, newRuntimeException, newRuntimeException, recycleDateTimeList, refereceHashCode, toStringGeneric, toStringIntern

Methods inherited from class de.bea.domingo.monitor.AbstractMonitorEnabled

getMonitor, setMonitor

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.bea.domingo.DBase

equals, hashCode

Method Detail

getInstance

static ViewProxy getInstance(NotesProxyFactory theFactory,
                             DDatabase database,
                             lotus.domino.View view,
                             DNotesMonitor monitor)

Returns a view object.

Parameters:

theFactory - the controlling factory

database - Notes database

view - the notes view object

monitor - the monitor

Returns:

a view object

refresh

public void refresh()

Description copied from interface: DView

Updates view contents with any changes that have occurred to the database since the View object was created, or since the last refresh.

Specified by:

refresh in interface DView

See Also:

DView.refresh()

getName

public java.lang.String getName()

Returns the name of a view.

Specified by:

getName in interface DView

Returns:

view name

See Also:

DView.getName()

getDocumentByKey

public DDocument getDocumentByKey(java.lang.String key,
                                  boolean exact)

Finds a document based on the first column value within a view. Returns null if there are no matching document.

Specified by:

getDocumentByKey in interface DView

Parameters:

key - - String A partial key must not be in a categorized colum!

exact - - boolean

Returns:

DDocument

See Also:

DView.getDocumentByKey(String, boolean)

getDocumentByKey

public DDocument getDocumentByKey(java.util.List keys,
                                  boolean exact)

Finds a document based on its column values within a view. Returns null if there are no matching document.

Specified by:

getDocumentByKey in interface DView

Parameters:

keys - - List(Column-Value) A partial key must not be in a categorized colum!

exact - - boolean

Returns:

DDocument

See Also:

DView.getDocumentByKey(List,boolean)

getAllDocumentsByKey

public java.util.Iterator getAllDocumentsByKey(java.util.List keys)

Finds documents based on their column values within a view. Returns all documents in the view whose column values partially match one of the keys. If no documents match, the collection is empty and the count is zero.

Note The use of partial matches with multiple keys may result in missed entries. If the first key is partial and the second column does not sort the same with the partial key as with the exact key, entries that fall out of sequence are missed. A partial key must not be in a categorized colum!

Specified by:

getAllDocumentsByKey in interface DView

Parameters:

keys - list of keys

Returns:

Iterator

See Also:

DView.getAllDocumentsByKey(java.util.List)

getAllDocumentsByKey

public java.util.Iterator getAllDocumentsByKey(java.lang.String key)

Finds documents based on their column values within a view. Returns all documents in the view whose column values partially match one of the keys. If no documents match, the collection is empty and the count is zero.

Note The use of partial matches with multiple keys may result in missed entries. If the first key is partial and the second column does not sort the same with the partial key as with the exact key, entries that fall out of sequence are missed. A partial key must not be in a categorized colum!

Specified by:

getAllDocumentsByKey in interface DView

Parameters:

key - key

Returns:

Iterator

See Also:

DView.getAllDocumentsByKey(java.lang.String)

getAllDocumentsByKey

public java.util.Iterator getAllDocumentsByKey(java.lang.String key,
                                               boolean exact)

Finds documents based on their column values within a view. Returns all documents in the view whose column values match each of the keys. If no documents match, the collection is empty and the count is zero.

Note The use of partial matches with multiple keys may result in missed entries. If the first key is partial and the second column does not sort the same with the partial key as with the exact key, entries that fall out of sequence are missed. A partial key must not be in a categorized colum!

Specified by:

getAllDocumentsByKey in interface DView

Parameters:

key - key

exact - True if you want to find an exact match. If you specify false or omit this parameter, a partial match succeeds. The use of partial matches with multiple keys may result in missed documents. If the first key is partial and the second column does not sort the same with the partial key as with the exact key, documents that fall out of sequence are missed. A partial key must not be in a categorized colum!

Returns:

Iterator all documents in the view whose column values match the keys. If no documents match, the collection is empty and the count is zero.

See Also:

DView.getAllDocumentsByKey(java.lang.String, boolean)

getAllDocumentsByKey

public java.util.Iterator getAllDocumentsByKey(java.util.List keys,
                                               boolean exact)

Finds documents based on their column values within a view. Returns all documents in the view whose column values match each of the keys. If no documents match, the collection is empty and the count is zero.

Note The use of partial matches with multiple keys may result in missed entries. If the first key is partial and the second column does not sort the same with the partial key as with the exact key, entries that fall out of sequence are missed. A partial key must not be in a categorized colum!

Specified by:

getAllDocumentsByKey in interface DView

Parameters:

keys - list of keys

exact - True if you want to find an exact match. If you specify false or omit this parameter, a partial match succeeds. The use of partial matches with multiple keys may result in missed documents. If the first key is partial and the second column does not sort the same with the partial key as with the exact key, documents that fall out of sequence are missed. A partial key must not be in a categorized colum!

Returns:

Iterator all documents in the view whose column values match the keys. If no documents match, the collection is empty and the count is zero.

See Also:

DView.getAllDocumentsByKey(java.util.List, boolean)

getAllDocumentsByKey

public java.util.Iterator getAllDocumentsByKey(java.util.Calendar key)

Finds documents based on their column values within a view. Returns all documents in the view whose column values partially match one of the keys. If no documents match, the collection is empty and the count is zero.

Note The use of partial matches with multiple keys may result in missed entries. If the first key is partial and the second column does not sort the same with the partial key as with the exact key, entries that fall out of sequence are missed. A partial key must not be in a categorized colum!

Specified by:

getAllDocumentsByKey in interface DView

Parameters:

key - key

Returns:

Iterator

See Also:

DView.getAllDocumentsByKey(java.util.Calendar)

getAllDocumentsByKey

public java.util.Iterator getAllDocumentsByKey(double key)

Finds documents based on their column values within a view. Returns all documents in the view whose column values partially match one of the keys. If no documents match, the collection is empty and the count is zero.

Note The use of partial matches with multiple keys may result in missed entries. If the first key is partial and the second column does not sort the same with the partial key as with the exact key, entries that fall out of sequence are missed. A partial key must not be in a categorized colum!

Specified by:

getAllDocumentsByKey in interface DView

Parameters:

key - key

Returns:

Iterator

See Also:

DView.getAllDocumentsByKey(double)

getAllDocumentsByKey

public java.util.Iterator getAllDocumentsByKey(int key)

Finds documents based on their column values within a view. Returns all documents in the view whose column values partially match one of the keys. If no documents match, the collection is empty and the count is zero.

Note The use of partial matches with multiple keys may result in missed entries. If the first key is partial and the second column does not sort the same with the partial key as with the exact key, entries that fall out of sequence are missed. A partial key must not be in a categorized colum!

Specified by:

getAllDocumentsByKey in interface DView

Parameters:

key - key

Returns:

Iterator

See Also:

DView.getAllDocumentsByKey(int)

getAllDocumentsByKey

public java.util.Iterator getAllDocumentsByKey(java.util.Calendar key,
                                               boolean exact)

Finds documents based on their column values within a view. Returns all documents in the view whose column values match each of the keys. If no documents match, the collection is empty and the count is zero.

Note The use of partial matches with multiple keys may result in missed entries. If the first key is partial and the second column does not sort the same with the partial key as with the exact key, entries that fall out of sequence are missed. A partial key must not be in a categorized colum!

Specified by:

getAllDocumentsByKey in interface DView

Parameters:

key - key

exact - True if you want to find an exact match. If you specify false or omit this parameter, a partial match succeeds. The use of partial matches with multiple keys may result in missed documents. If the first key is partial and the second column does not sort the same with the partial key as with the exact key, documents that fall out of sequence are missed. A partial key must not be in a categorized colum!

Returns:

Iterator all documents in the view whose column values match the keys. If no documents match, the collection is empty and the count is zero.

See Also:

DView.getAllDocumentsByKey(java.util.Calendar, boolean)

getAllDocumentsByKey

public java.util.Iterator getAllDocumentsByKey(double key,
                                               boolean exact)

Finds documents based on their column values within a view. Returns all documents in the view whose column values match each of the keys. If no documents match, the collection is empty and the count is zero.

Note The use of partial matches with multiple keys may result in missed entries. If the first key is partial and the second column does not sort the same with the partial key as with the exact key, entries that fall out of sequence are missed. A partial key must not be in a categorized colum!

Specified by:

getAllDocumentsByKey in interface DView

Parameters:

key - key

exact - True if you want to find an exact match. If you specify false or omit this parameter, a partial match succeeds. The use of partial matches with multiple keys may result in missed documents. If the first key is partial and the second column does not sort the same with the partial key as with the exact key, documents that fall out of sequence are missed. A partial key must not be in a categorized colum!

Returns:

Iterator all documents in the view whose column values match the keys. If no documents match, the collection is empty and the count is zero.

See Also:

DView.getAllDocumentsByKey(double, boolean)

getAllDocumentsByKey

public java.util.Iterator getAllDocumentsByKey(int key,
                                               boolean exact)

Finds documents based on their column values within a view. Returns all documents in the view whose column values match each of the keys. If no documents match, the collection is empty and the count is zero.

Note The use of partial matches with multiple keys may result in missed entries. If the first key is partial and the second column does not sort the same with the partial key as with the exact key, entries that fall out of sequence are missed. A partial key must not be in a categorized colum!

Specified by:

getAllDocumentsByKey in interface DView

Parameters:

key - key

exact - True if you want to find an exact match. If you specify false or omit this parameter, a partial match succeeds. The use of partial matches with multiple keys may result in missed documents. If the first key is partial and the second column does not sort the same with the partial key as with the exact key, documents that fall out of sequence are missed. A partial key must not be in a categorized colum!

Returns:

Iterator all documents in the view whose column values match the keys. If no documents match, the collection is empty and the count is zero.

See Also:

DView.getAllDocumentsByKey(int, boolean)

getAllDocuments

public java.util.Iterator getAllDocuments()

Returns an Iterator to loop over all documents in the view.

Specified by:

getAllDocuments in interface DView

Returns:

Iterator

See Also:

DView.getAllDocuments()

toString

public java.lang.String toString()

Returns a short description of an instance.

Specified by:

toString in interface DBase

Overrides:

toString in class java.lang.Object

Returns:

short description of an instance

See Also:

Object.toString()

getAllEntries

public java.util.Iterator getAllEntries()

Iterator over all entries in a view in view order.

A view entry collection contains only document entries (no categories or totals). If a view is filtered by FTSearch, this property returns the entries in the filtered view.

Specified by:

getAllEntries in interface DView

Returns:

Iterator over all entries in a view in view order.

See Also:

DView.getAllEntries()

getAllEntriesReverse

public java.util.Iterator getAllEntriesReverse()

Iterator over all entries in a view in reverse view order.

A view entry collection contains only document entries (no categories or totals). If a view is filtered by FTSearch, this property returns the entries in the filtered view.

Specified by:

getAllEntriesReverse in interface DView

Returns:

Iterator over all entries in a view in view order.

See Also:

DView.getAllEntriesReverse()()

getEntryByKey

public DViewEntry getEntryByKey(java.lang.String key)

Finds a view entry based on its column values within a view.

You create a key or vector of keys, where each key corresponds to a value in a sorted column in the view. The method returns the first entry with column values that match the keys.

This method returns only the first entry with column values that match the strings you indicate. To locate all matching documents, use DView.getAllEntriesByKey(String)

Specified by:

getEntryByKey in interface DView

Parameters:

key - String that is compared to the first sorted column in the view.

Returns:

The first entry in the view with column values that match the keys. Returns null if there are no matching entries.

See Also:

DView.getEntryByKey(java.lang.String)

getEntryByKey

public DViewEntry getEntryByKey(java.lang.String key,
                                boolean exact)

Finds a view entry based on its column values within a view.

You create a key or vector of keys, where each key corresponds to a value in a sorted column in the view. The method returns the first entry with column values that match the keys.

This method returns only the first entry with column values that match the strings you indicate. To locate all matching documents, use DView.getAllEntriesByKey(String)

Specified by:

getEntryByKey in interface DView

Parameters:

key - String that is compared to the first sorted column in the view.

exact - use true if you want an exact match or false for a partial one

Returns:

The first entry in the view with column values that match the keys. Returns null if there are no matching entries.

See Also:

DView.getEntryByKey(java.lang.String, boolean)

getEntryByKey

public DViewEntry getEntryByKey(java.util.List keys)

Finds a view entry based on its column values within a view.

You create a key or vector of keys, where each key corresponds to a value in a sorted column in the view. The method returns the first entry with column values that match the keys.

This method returns only the first entry with column values that match the strings you indicate. To locate all matching documents, use DView.getAllEntriesByKey(String)

Specified by:

getEntryByKey in interface DView

Parameters:

keys - A String object that is compared to the first sorted column in the view. The List only must contain the types String, Date, Double and Integer

Returns:

The first entry in the view with column values that match the keys. Returns null if there are no matching entries.

See Also:

DView.getEntryByKey(java.util.List)

getEntryByKey

public DViewEntry getEntryByKey(java.util.List keys,
                                boolean exact)

Finds a view entry based on its column values within a view.

You create a key or vector of keys, where each key corresponds to a value in a sorted column in the view. The method returns the first entry with column values that match the keys.

This method returns only the first entry with column values that match the strings you indicate. To locate all matching documents, use DView.getAllEntriesByKey(String)

Specified by:

getEntryByKey in interface DView

Parameters:

keys - A String object that is compared to the first sorted column in the view. The List only must contain the types String, Date, Double and Integer

exact - use true if you want an exact match or false for a partial one

Returns:

The first entry in the view with column values that match the keys. Returns null if there are no matching entries.

See Also:

DView.getEntryByKey(java.util.List, boolean)

getAllEntries

public java.util.Iterator getAllEntries(DViewEntry entry)

Iterator over all entries in a view in view order starting with a given entry.

A view entry collection contains only document entries (no categories or totals). If a view is filtered by FTSearch, this property returns the entries in the filtered view.

Specified by:

getAllEntries in interface DView

Parameters:

entry - A Document or ViewEntry object. Cannot be null.

Returns:

Iterator over all entries in a view in view order starting with a given entry.

See Also:

DView.getAllEntries(de.bea.domingo.DViewEntry)

getAllEntriesByKey

public java.util.Iterator getAllEntriesByKey(java.lang.String key)

Finds view entries of type document based on their column values within a view. You create a key or vector of keys, where each key corresponds to a value in a sorted column in the view. The method returns all entries whose column values match the keys. Matches are not case-sensitive.

Note For the getAllEntriesByKey method to work using a key, you must have at least one column sorted for every key in the array.

Note The use of partial matches with multiple keys may result in missed entries. If the first key is partial and the second column does not sort the same with the partial key as with the exact key, entries that fall out of sequence are missed.

Specified by:

getAllEntriesByKey in interface DView

Parameters:

key - A String object that is compared to the first sorted column in the view.

Returns:

a iterator providing all matching ViewEntrys, Entries returned by this method are in view order.

See Also:

DView.getAllEntriesByKey(java.lang.String)

getAllEntriesByKey

public java.util.Iterator getAllEntriesByKey(java.lang.String key,
                                             boolean exact)

Finds view entries of type document based on their column values within a view. You create a key or vector of keys, where each key corresponds to a value in a sorted column in the view. The method returns all entries whose column values match the keys. Matches are not case-sensitive.

Note For the getAllEntriesByKey method to work using a key, you must have at least one column sorted for every key in the array.

Note The use of partial matches with multiple keys may result in missed entries. If the first key is partial and the second column does not sort the same with the partial key as with the exact key, entries that fall out of sequence are missed.

Specified by:

getAllEntriesByKey in interface DView

Parameters:

key - A String object that is compared to the first sorted column in the view.

exact - use true if you want an exact match or false for a partial one

Returns:

a iterator providing all matching ViewEntrys, Entries returned by this method are in view order.

See Also:

DView.getAllEntriesByKey(java.lang.String, boolean)

getAllEntriesByKey

public java.util.Iterator getAllEntriesByKey(java.util.List keys)

Finds view entries of type document based on their column values within a view. You create a key or vector of keys, where each key corresponds to a value in a sorted column in the view. The method returns all entries whose column values match the keys. Matches are not case-sensitive.

Note For the getAllEntriesByKey method to work using a key, you must have at least one column sorted for every key in the array.

Note The use of partial matches with multiple keys may result in missed entries. If the first key is partial and the second column does not sort the same with the partial key as with the exact key, entries that fall out of sequence are missed.

Specified by:

getAllEntriesByKey in interface DView

Parameters:

keys - A String object that is compared to the first sorted column in the view. The List only must contain the types String, Date, Double and Integer

Returns:

a iterator providing all matching ViewEntrys, Entries returned by this method are in view order.

See Also:

DView.getAllEntriesByKey(java.util.List)

getAllEntriesByKey

public java.util.Iterator getAllEntriesByKey(java.util.List keys,
                                             boolean exact)

Finds view entries of type document based on their column values within a view. You create a key or vector of keys, where each key corresponds to a value in a sorted column in the view. The method returns all entries whose column values match the keys. Matches are not case-sensitive.

Note For the getAllEntriesByKey method to work using a key, you must have at least one column sorted for every key in the array.

Note The use of partial matches with multiple keys may result in missed entries. If the first key is partial and the second column does not sort the same with the partial key as with the exact key, entries that fall out of sequence are missed.

Specified by:

getAllEntriesByKey in interface DView

Parameters:

keys - A List object that is compared to the first sorted column in the view. The List only must contain the types String, Date, Double and Integer

exact - use true if you want an exact match or false for a partial one

Returns:

a iterator providing all matching ViewEntrys, Entries returned by this method are in view order.

See Also:

DView.getAllEntriesByKey(java.util.List, boolean)

getAllEntriesByKey

public java.util.Iterator getAllEntriesByKey(java.util.Calendar start,
                                             java.util.Calendar end,
                                             boolean exact)

Finds view entries of type document based on their column values within a view. You create a key or vector of keys, where each key corresponds to a value in a sorted column in the view. The method returns all entries whose column values match the keys. Matches are not case-sensitive.

Note For the getAllEntriesByKey method to work using a key, you must have at least one column sorted for every key in the array.

Note The use of partial matches with multiple keys may result in missed entries. If the first key is partial and the second column does not sort the same with the partial key as with the exact key, entries that fall out of sequence are missed.

Specified by:

getAllEntriesByKey in interface DView

Parameters:

start - A Calendar object that represents the start of a date range. Compared to the first column in the view.

end - A Calendar object that represents the start of a end range. Compared to the first column in the view.

exact - use true if you want an exact match or false for a partial one

Returns:

a iterator providing all matching ViewEntrys, Entries returned by this method are in view order.

See Also:

DView.getAllEntriesByKey(java.util.Calendar, java.util.Calendar, boolean)

getDViewEntry

ViewEntryProxy getDViewEntry(DBase parent,
                             lotus.domino.ViewEntry viewEntry)

Creates and returns a Proxy for a ViewEntry. Returns null if the viewEntry parameter is null.

Parameters:

parent - the parent object

viewEntry - to Notes ViewEntry

Returns:

Proxy for a ViewEntry

getAllCategories

public java.util.Iterator getAllCategories()

Finds view entries of type category. This method returns an iterator over all top level categories. Sub categories are not included. Use DView.getAllCategories(int) to retrieve sub categories.

Specified by:

getAllCategories in interface DView

Returns:

a iterator providing all matching ViewEntrys, Entries returned by this method are in view order.

See Also:

DView.getAllCategories()

getAllCategories

public java.util.Iterator getAllCategories(int level)

Finds view entries of type category upto a given level.

Specified by:

getAllCategories in interface DView

Parameters:

level - The maximum level of navigation 0 (top level) through 30 (default).

Returns:

a iterator providing all matching ViewEntrys, Entries returned by this method are in view order.

See Also:

DView.getAllCategories(int)

getAllCategoriesByKey

public java.util.Iterator getAllCategoriesByKey(java.lang.String key)

Deprecated.

Finds view entries of type category where the category partially matches the given key. Matches are not case-sensitive.

Note For the getAllCategoriesByKey method to work using a key, you must have at least one column categorized.

Note The use of partial matches with multiple keys may result in missed entries. If the first key is partial and the second column does not sort the same with the partial key as with the exact key, entries that fall out of sequence are missed.

Specified by:

getAllCategoriesByKey in interface DView

Parameters:

key - A String that is compared to the first categorized column in the view.

Returns:

a iterator providing all matching ViewEntrys, Entries returned by this method are in view order.

See Also:

DView.getAllCategoriesByKey(java.lang.String)

getAllCategoriesByKey

public java.util.Iterator getAllCategoriesByKey(java.lang.String key,
                                                int level)

Deprecated.

Finds view entries of type category upto a given level where the categories partially match the given key. Matches are not case-sensitive.

Note For the getAllCategoriesByKey method to work using a key, you must have at least one column categorized for every key in the array.

Note The use of partial matches with multiple keys may result in missed entries. If the first key is partial and the second column does not sort the same with the partial key as with the exact key, entries that fall out of sequence are missed.

Specified by:

getAllCategoriesByKey in interface DView

Parameters:

key - A List object that is compared to the first sorted column in the view. The List only must contain the types String, Date, Double and Integer

level - The maximum level of navigation 0 (top level) through 30 (default).

Returns:

a iterator providing all matching ViewEntrys, Entries returned by this method are in view order.

See Also:

DView.getAllCategoriesByKey(java.lang.String, int)

getAllCategoriesByKey

public java.util.Iterator getAllCategoriesByKey(java.lang.String key,
                                                boolean exact)

Deprecated.

Finds view entries of type category upto a given level where the categories match the given key. Finds view entries of type category upto a given level based on their column values within a view. You create a key or vector of keys, where each key corresponds to a value in a sorted column in the view. The method returns all entries whose column values match the keys. Matches are not case-sensitive.

Note For the getAllCategoriesByKey method to work using a key, you must have at least one column categorized for every key in the array.

Note The use of partial matches with multiple keys may result in missed entries. If the first key is partial and the second column does not sort the same with the partial key as with the exact key, entries that fall out of sequence are missed.

Specified by:

getAllCategoriesByKey in interface DView

Parameters:

key - A List object that is compared to the first sorted column in the view. The List only must contain the types String, Date, Double and Integer

exact - use true if you want an exact match or false for a partial one

Returns:

a iterator providing all matching ViewEntrys, Entries returned by this method are in view order.

See Also:

DView.getAllCategoriesByKey(java.lang.String, boolean)

getAllCategoriesByKey

public java.util.Iterator getAllCategoriesByKey(java.lang.String key,
                                                int level,
                                                boolean exact)

Deprecated.

Finds view entries of type category upto a given level based on their column values within a view. You create a key or vector of keys, where each key corresponds to a value in a sorted column in the view. The method returns all entries whose column values match the keys. Matches are not case-sensitive.

Note For the getAllCategoriesByKey method to work using a key, you must have at least one column categorized for every key in the array.

Note The use of partial matches with multiple keys may result in missed entries. If the first key is partial and the second column does not sort the same with the partial key as with the exact key, entries that fall out of sequence are missed.

Specified by:

getAllCategoriesByKey in interface DView

Parameters:

key - A List object that is compared to the first sorted column in the view. The List only must contain the types String, Date, Double and Integer

level - The maximum level of navigation 0 (top level) through 30 (default).

exact - use true if you want an exact match or false for a partial one

Returns:

a iterator providing all matching ViewEntrys, Entries returned by this method are in view order.

See Also:

DView.getAllCategoriesByKey(java.lang.String, int, boolean)

getAllCategoriesByKey

public java.util.Iterator getAllCategoriesByKey(java.util.List key)

Deprecated.

Finds view entries of type category upto a given level based on their column values within a view. You create a key or vector of keys, where each key corresponds to a value in a sorted column in the view. The method returns all entries whose column values match the keys. Matches are not case-sensitive.

Note For the getAllCategoriesByKey method to work using a key, you must have at least one column categorized for every key in the array.

Note The use of partial matches with multiple keys may result in missed entries. If the first key is partial and the second column does not sort the same with the partial key as with the exact key, entries that fall out of sequence are missed.

Specified by:

getAllCategoriesByKey in interface DView

Parameters:

key - A List object that is compared to the first sorted column in the view. The List only must contain the types String, Date, Double and Integer

Returns:

a iterator providing all matching ViewEntrys, Entries returned by this method are in view order.

See Also:

DView.getAllCategoriesByKey(java.util.List)

getAllCategoriesByKey

public java.util.Iterator getAllCategoriesByKey(java.util.List key,
                                                int level)

Deprecated.

Finds view entries of type category upto a given level based on their column values within a view. You create a key or vector of keys, where each key corresponds to a value in a sorted column in the view. The method returns all entries whose column values match the keys. Matches are not case-sensitive.

Note For the getAllCategoriesByKey method to work using a key, you must have at least one column categorized for every key in the array.

Note The use of partial matches with multiple keys may result in missed entries. If the first key is partial and the second column does not sort the same with the partial key as with the exact key, entries that fall out of sequence are missed.

Specified by:

getAllCategoriesByKey in interface DView

Parameters:

key - A List object that is compared to the first sorted column in the view. The List only must contain the types String, Date, Double and Integer

level - The maximum level of navigation 0 (top level) through 30 (default).

Returns:

a iterator providing all matching ViewEntrys, Entries returned by this method are in view order.

See Also:

DView.getAllCategoriesByKey(java.util.List, int)

getAllCategoriesByKey

public java.util.Iterator getAllCategoriesByKey(java.util.List key,
                                                boolean exact)

Deprecated.

Finds view entries of type category upto a given level based on their column values within a view. You create a key or vector of keys, where each key corresponds to a value in a sorted column in the view. The method returns all entries whose column values match the keys. Matches are not case-sensitive.

Note For the getAllCategoriesByKey method to work using a key, you must have at least one column categorized for every key in the array.

Note The use of partial matches with multiple keys may result in missed entries. If the first key is partial and the second column does not sort the same with the partial key as with the exact key, entries that fall out of sequence are missed.

Specified by:

getAllCategoriesByKey in interface DView

Parameters:

key - A List object that is compared to the first sorted column in the view. The List only must contain the types String, Date, Double and Integer

exact - use true if you want an exact match or false for a partial one

Returns:

a iterator providing all matching ViewEntrys, Entries returned by this method are in view order.

See Also:

DView.getAllCategoriesByKey(java.util.List, boolean)

getAllCategoriesByKey

public java.util.Iterator getAllCategoriesByKey(java.util.List key,
                                                int level,
                                                boolean exact)

Deprecated.

Finds view entries of type category upto a given level based on their column values within a view. You create a key or vector of keys, where each key corresponds to a value in a sorted column in the view. The method returns all entries whose column values match the keys. Matches are not case-sensitive.

Note For the getAllCategoriesByKey method to work using a key, you must have at least one column categorized for every key in the array.

Note The use of partial matches with multiple keys may result in missed entries. If the first key is partial and the second column does not sort the same with the partial key as with the exact key, entries that fall out of sequence are missed.

Specified by:

getAllCategoriesByKey in interface DView

Parameters:

key - A List object that is compared to the first sorted column in the view. The List only must contain the types String, Date, Double and Integer

level - The maximum level of navigation 0 (top level) through 30 (default).

exact - use true if you want an exact match or false for a partial one

Returns:

a iterator providing all matching ViewEntrys, Entries returned by this method are in view order.

See Also:

DView.getAllCategoriesByKey(java.util.List, int, boolean)

fullTextSearch

public int fullTextSearch(java.lang.String query)

Conducts a full-text search on all documents in a view and filters the view so it represents only those documents that match the full-text query. This method does not find word variants.

See DView.fullTextSearch(String, int) for more details.

Specified by:

fullTextSearch in interface DView

Parameters:

query - The full-text query. See the "Query Syntax" for details

Returns:

The number of documents in the view after the search. Each of these documents matches the query.

See Also:

DView.fullTextSearch(java.lang.String)

fullTextSearch

public int fullTextSearch(java.lang.String query,
                          int maxdocs)

Conducts a full-text search on all documents in a view and filters the view so it represents only those documents that match the full-text query. This method does not find word variants.

Usage

After calling FTSearch, you can use the regular View methods to navigate the result, which is a subset of the documents in the view. If the database is not full-text indexed, the documents in the subset are in the same order as they are in the original view. However, if the database is full-text indexed, the documents in the subset are sorted into descending order of relevance. The method getFirstDocument returns the first document in the subset, getLastDocument returns the last document, and so on.

Use the DView.clear() method to clear the full-text search filtering. The View methods now navigate to the full set of documents in the view.

If the database is not full-text indexed, this method works, but less efficiently. To test for an index, use DDatabase.isFTIndexed().

To create an index on a local database, use DDatabase.updateFTIndex(boolean).

Query syntax

To search for a word or phrase, enter the word or phrase as is, except that search keywords must be enclosed in quotes. Remember to escape quotes if you are inside a literal. Wildcards, operators, and other syntax are permitted. For the complete syntax rules, see "Finding documents in a database" in Lotus Notes 6 Help.

Specified by:

fullTextSearch in interface DView

Parameters:

query - The full-text query. See the "Query Syntax" for details

maxdocs - The maximum number of documents you want returned from the search. If you want to receive all documents that match the query, specify 0

Returns:

The number of documents in the view after the search. Each of these documents matches the query.

See Also:

DView.fullTextSearch(java.lang.String, int)

clear

public void clear()

Clears the full-text search filtering on a view. Subsequent calls to getDocument methods get all documents in the view, not just the search results.

Specified by:

clear in interface DView

See Also:

DView.clear()

getSelectionFormula

public java.lang.String getSelectionFormula()

Returns the selection formula of a view.

Specified by:

getSelectionFormula in interface DView

Returns:

selection formula

See Also:

DView.getSelectionFormula()

setSelectionFormula

public void setSelectionFormula(java.lang.String formula)

Sets the selection formula of a view.

Specified by:

setSelectionFormula in interface DView

Parameters:

formula - new selection formula

See Also:

DView.setSelectionFormula(java.lang.String)

getColumnNames

public java.util.List getColumnNames()

Retutrns the names of the columns in a view. The order of the column names in the list corresponds to the order of the columns in the view, from left to right.

Specified by:

getColumnNames in interface DView

Returns:

list ofd column names

See Also:

DView.getColumnNames()

getColumnCount

public int getColumnCount()

Returns the number of columns in a view.

Specified by:

getColumnCount in interface DView

Returns:

number of columns

See Also:

DView.getColumnNames()

getColumn

public DViewColumn getColumn(int i)

Returns a specified column in a view.

Specified by:

getColumn in interface DView

Parameters:

i - A column number where 1 is the first column. Cannot be less than 1 or greater than the number of columns in the view.

Returns:

the specified column.

See Also:

DView.getColumnNames()

getColumns

public java.util.List getColumns()

Returns the columns in a view.

The order of ViewColumn objects in the vector corresponds to the order of the columns in the view, from left to right.

Specified by:

getColumns in interface DView

Returns:

list of all columns

See Also:

DView.getColumnNames()