com.chemaxon.overlap.io

Interface MasterStorage<T>

Type Parameters:

T - Type of structures

All Superinterfaces:

Serializable

All Known Subinterfaces:

MasterMoleculeStorage, MasterStringStorage

All Known Implementing Classes:

AllAbsentMasterMoleculeStorage, CompactStringStorage, MasterMoleculeStorageImpl

public interface MasterStorage<T>
extends Serializable

Master structure storage represents the molecules from a repository.

Typically retrieval of individual structures can be slow (in ms range) compared to descriptor comparison/screening speed requirements. Intended usage is provide visual display of structures in a user interface.

It is possible that certain structures are not retrievable; clients must be prepared for the handling of missing structures.

Method Summary

Modifier and Type	Method and Description
default boolean	areAllAbsent() Check for all absent.
Optional<T>	get(int index) Get given structure identified with an index.
int	getAbsentCount() Number of absent structures.
Class<T>	getStoredType() Represented type.
boolean	isPresent(int index) Check if given entity is present.
int	size() Number of structures in the storage.

Method Detail

getStoredType

Class<T> getStoredType()

Represented type.

Returns:

represented type

size

int size()

Number of structures in the storage.

Returns:

Number of structures in the storage

getAbsentCount

int getAbsentCount()

Number of absent structures.

Returns:

Number of absent structures.

areAllAbsent

default boolean areAllAbsent()

Check for all absent.

Returns:

true when are elements are absent

isPresent

boolean isPresent(int index)
           throws IndexOutOfBoundsException

Check if given entity is present.

Parameters:

index - Structure index

Returns:

true when structure is present

Throws:

IndexOutOfBoundsException - when index is less than 0 or greater or equal than size()

get

Optional<T> get(int index)
         throws IndexOutOfBoundsException

Get given structure identified with an index.

Parameters:

index - Structure index

Returns:

Structure if present

Throws:

IndexOutOfBoundsException - when index is less than 0 or greater or equal than size()