com.chemaxon.overlap.storage

Interface UnguardedPagedStorage<T extends Serializable>

Type Parameters:

T - Unguarded form of the descriptors

All Superinterfaces:

Serializable

All Known Implementing Classes:

UnguardedPagedStorageImpl

public interface UnguardedPagedStorage<T extends Serializable>
extends Serializable

Page organized storage of unguarded descriptors.

Method Summary

Modifier and Type	Method and Description
String	getDescriptorAsString(int index, boolean recognizeArrays) Retrieve descriptor as String.
T	getUnguardedDescriptor(int index) Retrieve a descriptor.
UnmodifiableIterator<ImmutableList<T>>	iterateDescriptorPages() Iterate descriptor pages.
UnmodifiableIterator<ImmutableList<T>>	iterateDescriptorPages(int pagesize) Iterate descriptor pages.
UnmodifiableIterator<T>	iterateDescriptors() Iterate descriptors.
int	size() Total number of descriptors stored.
void	traverse(UnguardedVisitor<T> visitor, SubProgressObserver po) Traverse storage on single thread.

Method Detail

size

int size()

Total number of descriptors stored.

Returns:

Size

iterateDescriptors

UnmodifiableIterator<T> iterateDescriptors()

Iterate descriptors.

Returns:

Iterator for stored descriptors

iterateDescriptorPages

UnmodifiableIterator<ImmutableList<T>> iterateDescriptorPages(int pagesize)

Iterate descriptor pages. Descriptors will be repackaged into new pages.

Parameters:

pagesize - Number of descriptors to page together

Returns:

Iterator of descriptor lists

iterateDescriptorPages

UnmodifiableIterator<ImmutableList<T>> iterateDescriptorPages()

Iterate descriptor pages. Use representation specific page size.

Returns:

Iterator of descriptor lists

traverse

void traverse(UnguardedVisitor<T> visitor,
              SubProgressObserver po)

Traverse storage on single thread. Iterate over pages/descriptors and invoke the supplied callback.

Note that the callback must not modify passed descriptors.

Parameters:

visitor - Callback to invoke

po - ProgressObserver to track progress. Upon completion ProgressObserver.done() will be invoked.

getDescriptorAsString

String getDescriptorAsString(int index,
                             boolean recognizeArrays)

Retrieve descriptor as String.

This operation is recommended for debug only. Execution might be slow.

Parameters:

index - Index of descriptor

recognizeArrays - Recognize arrays and traverse its elements

Returns:

Descriptor as String

getUnguardedDescriptor

T getUnguardedDescriptor(int index)

Retrieve a descriptor.

Parameters:

index - Descriptor index

Returns:

Unguarded descriptor