com.hcl.domino.data

Interface IndexedTypedAccess

All Known Subinterfaces:

CollectionEntry, DeletionStub

public interface IndexedTypedAccess

Common interface to read Domino data with a specific type from an indexable source, such as view column values.

Method Summary

Modifier and Type	Method and Description
<T> T	get(int index, Class<T> valueType, T defaultValue) Returns an item value converted to the specified data type. We currently support the following value types out of the box: String Integer Long Double DominoDateTime LocalDate LocalTime OffsetDateTime TemporalAccessor (returned as DominoDateTime) Additional value types are supported by implementing and registering DocumentValueConverter as Java services.
<T> List<T>	getAsList(int index, Class<T> valueType, List<T> defaultValue) Returns a list of item values converted to the specified data type. We currently support the following value types out of the box: String Integer Long Double DominoDateTime LocalDate LocalTime OffsetDateTime TemporalAccessor (returned as DominoDateTime) Additional value types are supported by implementing and registering DocumentValueConverter as Java services.
int	getIndexedValueCount()

Method Detail

getIndexedValueCount

int getIndexedValueCount()

Returns:

the number of value entries available to read

get

<T> T get(int index,
          Class<T> valueType,
          T defaultValue)

Returns an item value converted to the specified data type.

We currently support the following value types out of the box:

• String
• Integer
• Long
• Double
• DominoDateTime
• LocalDate
• LocalTime
• OffsetDateTime
• TemporalAccessor (returned as DominoDateTime)

Additional value types are supported by implementing and registering DocumentValueConverter as Java services.

Type Parameters:

T - type of return value

Parameters:

index - the index of the value to retrieve

valueType - class of return value

defaultValue - default value returned of object does not contain property

Returns:

return value

Throws:

IllegalArgumentException - if the specified value type is unsupported

getAsList

<T> List<T> getAsList(int index,
                      Class<T> valueType,
                      List<T> defaultValue)

Returns a list of item values converted to the specified data type.

We currently support the following value types out of the box:

• String
• Integer
• Long
• Double
• DominoDateTime
• LocalDate
• LocalTime
• OffsetDateTime
• TemporalAccessor (returned as DominoDateTime)

Additional value types are supported by implementing and registering DocumentValueConverter as Java services.

Type Parameters:

T - type of return value

Parameters:

index - the index of the value to retrieve

valueType - class of return value

defaultValue - default value returned of object does not contain property

Returns:

value list

Throws:

IllegalArgumentException - if the specified value type is unsupported