de.bea.domingo
Interface DView

All Superinterfaces:

DBase, java.io.Serializable

All Known Implementing Classes:

ViewHttp, ViewProxy

public interface DView
extends DBase

Represents a view or folder of a database and provides access to documents within it.

Author:

Kurt Riede

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. not yet fully implemented and not yet tested
java.util.Iterator	getAllCategoriesByKey(java.util.List key, boolean exact) Deprecated. not yet fully implemented and not yet tested
java.util.Iterator	getAllCategoriesByKey(java.util.List key, int level) Deprecated. not yet fully implemented and not yet tested
java.util.Iterator	getAllCategoriesByKey(java.util.List key, int level, boolean exact) Deprecated. not yet fully implemented and not yet tested
java.util.Iterator	getAllCategoriesByKey(java.lang.String key) Deprecated. not yet fully implemented and not yet tested
java.util.Iterator	getAllCategoriesByKey(java.lang.String key, boolean exact) Deprecated. not yet fully implemented and not yet tested
java.util.Iterator	getAllCategoriesByKey(java.lang.String key, int level) Deprecated. not yet fully implemented and not yet tested
java.util.Iterator	getAllCategoriesByKey(java.lang.String key, int level, boolean exact) Deprecated. not yet fully implemented and not yet tested
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 key) Finds view entries of type document based on their column values within a view.
java.util.Iterator	getAllEntriesByKey(java.util.List key, 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.
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.
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.

Methods inherited from interface de.bea.domingo.DBase

equals, hashCode, toString

Method Detail

refresh

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.

getName

java.lang.String getName()

Returns the name of a view.

Returns:

view name

getDocumentByKey

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.

Parameters:

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

exact - - boolean

Returns:

DDocument

getDocumentByKey

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.

Parameters:

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

exact - - boolean

Returns:

DDocument

getAllDocumentsByKey

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!

Parameters:

key - key

Returns:

Iterator

getAllDocumentsByKey

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!

Parameters:

key - key

Returns:

Iterator

getAllDocumentsByKey

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!

Parameters:

key - key

Returns:

Iterator

getAllDocumentsByKey

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!

Parameters:

key - key

Returns:

Iterator

getAllDocumentsByKey

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!

Parameters:

keys - list of keys

Returns:

Iterator

getAllDocumentsByKey

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!

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.

getAllDocumentsByKey

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!

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.

getAllDocumentsByKey

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!

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.

getAllDocumentsByKey

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!

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.

getAllDocumentsByKey

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!

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.

getAllDocuments

java.util.Iterator getAllDocuments()

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

Returns:

Iterator

getAllEntries

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.

Returns:

Iterator over all entries in a view in view order.

See Also:

DViewEntry

getAllEntriesReverse

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.

Returns:

Iterator over all entries in a view in view order.

See Also:

DViewEntry

getEntryByKey

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 getAllEntriesByKey(String)

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.

getEntryByKey

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 getAllEntriesByKey(String)

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.

getEntryByKey

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 getAllEntriesByKey(String)

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.

getEntryByKey

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 getAllEntriesByKey(String)

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.

getAllEntries

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.

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:

DViewEntry

getAllEntriesByKey

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.

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:

DViewEntry

getAllEntriesByKey

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.

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:

DViewEntry

getAllEntriesByKey

java.util.Iterator getAllEntriesByKey(java.util.List 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.

Parameters:

key - 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:

DViewEntry

getAllEntriesByKey

java.util.Iterator getAllEntriesByKey(java.util.List 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.

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:

DViewEntry

getAllEntriesByKey

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.

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:

DViewEntry

getAllCategories

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 getAllCategories(int) to retrieve sub categories.

Returns:

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

See Also:

DViewEntry

getAllCategories

java.util.Iterator getAllCategories(int level)

Finds view entries of type category upto a given level.

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:

DViewEntry

getAllCategoriesByKey

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

Deprecated. not yet fully implemented and not yet tested

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.

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:

DViewEntry

getAllCategoriesByKey

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

Deprecated. not yet fully implemented and not yet tested

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.

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:

DViewEntry

getAllCategoriesByKey

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

Deprecated. not yet fully implemented and not yet tested

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.

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:

DViewEntry

getAllCategoriesByKey

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

Deprecated. not yet fully implemented and not yet tested

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.

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:

DViewEntry

getAllCategoriesByKey

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

Deprecated. not yet fully implemented and not yet tested

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.

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:

DViewEntry

getAllCategoriesByKey

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

Deprecated. not yet fully implemented and not yet tested

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.

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:

DViewEntry

getAllCategoriesByKey

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

Deprecated. not yet fully implemented and not yet tested

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.

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:

DViewEntry

getAllCategoriesByKey

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

Deprecated. not yet fully implemented and not yet tested

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.

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

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:

DViewEntry

fullTextSearch

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 fullTextSearch(String, int) for more details.

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.

fullTextSearch

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 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.

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.

clear

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.

setSelectionFormula

void setSelectionFormula(java.lang.String formula)

Sets the selection formula of a view.

Parameters:

formula - new selection formula

Since:

Lotus Notes R6.5

getSelectionFormula

java.lang.String getSelectionFormula()

Returns the selection formula of a view.

Returns:

selection formula

Since:

Lotus Notes R6.5

getColumnNames

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.

Returns:

list ofd column names

getColumnCount

int getColumnCount()

Returns the number of columns in a view.

Returns:

number of columns

getColumn

DViewColumn getColumn(int i)

Returns a specified column in a view.

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.

getColumns

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.

Returns:

list of all columns