com.hcl.domino.data

Interface IDTable

All Superinterfaces:

Collection<Integer>, IAdaptable, Iterable<Integer>, Set<Integer>

All Known Subinterfaces:

DocumentSelection

public interface IDTable
extends IAdaptable, Set<Integer>

Wraps the C API IDTable, a very efficient set of note ids that is sorted in ascending order

Field Summary

Fields

Modifier and Type	Field and Description
static long	NOTEID_FLAG_DELETED special bitflag that is applied to note ids if a document has been reported as deleted

Method Summary

Modifier and Type	Method and Description
Object	clone() Creates a copy of this IDTable
Optional<DominoDateTime>	getDateTime() Returns a DominoDateTime set in this IDTable via a database search (e.g.
IDTable	intersect(Collection<Integer> noteIds) This function creates the intersection of two ID sets. The resulting table contains those IDs that are common to both source tables.
boolean	isInverted() Sense of list inverted (reserved for use by caller only)
boolean	isModified() Set by Insert/Delete and can be cleared by caller if desired
Iterator<Integer>	reverseIterator() Returns a note id iterator in reverse order
void	setDateTime(TemporalAccessor dt) Changes the datetime value stored in this IDTable
void	setInverted(boolean b) Sets the inverted flag
void	setModified(boolean modified) Sets the modified flag
int[]	toIntArray() Copies the contents of the ID table into an array of ints

Methods inherited from interface com.hcl.domino.data.IAdaptable

getAdapter

Methods inherited from interface java.util.Set

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

NOTEID_FLAG_DELETED

static final long NOTEID_FLAG_DELETED

special bitflag that is applied to note ids if a document has been reported as deleted

See Also:

Constant Field Values

Method Detail

intersect

IDTable intersect(Collection<Integer> noteIds)

This function creates the intersection of two ID sets.
The resulting table contains those IDs that are common to both source tables.

Parameters:

noteIds - other IDTable or Set of note ids

Returns:

intersection

reverseIterator

Iterator<Integer> reverseIterator()

Returns a note id iterator in reverse order

Returns:

iterator

isInverted

boolean isInverted()

Sense of list inverted (reserved for use by caller only)

Returns:

true if inverted

setInverted

void setInverted(boolean b)

Sets the inverted flag

Parameters:

b - new value of inverted flag

isModified

boolean isModified()

Set by Insert/Delete and can be cleared by caller if desired

Returns:

true if modified

setModified

void setModified(boolean modified)

Sets the modified flag

Parameters:

modified - new modified flag value

getDateTime

Optional<DominoDateTime> getDateTime()

Returns a DominoDateTime set in this IDTable via a database search (e.g. a cutoff date for incremental searches)

Returns:

an Optional describing the "until" time set in this table, or an empty one if this has not been set

setDateTime

void setDateTime(TemporalAccessor dt)

Changes the datetime value stored in this IDTable

Parameters:

dt - new datetime or null

clone

Object clone()

Creates a copy of this IDTable

Returns:

IDTable copy

toIntArray

int[] toIntArray()

Copies the contents of the ID table into an array of ints

Returns:

the contents of this ID table as an int[]

Since:

1.0.9