textbender.a.u.transfer.clipboard
Class IndexBlockMapW

java.lang.Object
  IndexBlockMap
      IndexBlockMapW

All Implemented Interfaces:

Serializable

@ThreadRestricted
final class IndexBlockMapW
extends IndexBlockMap

Writeable map of index blocks.

Nested Class Summary

(package private) static class

IndexBlockMapW.KeySD A key for index block lookup, per getOrCreateIndexBlock.

Field Summary

Fields inherited from class IndexBlockMap

list, PACKAGE_DIRECTORY, PERSISTANT_STORE_FILE

Method Summary

(package private) static IndexBlockMapW	_createUnchecked()
(package private) static IndexBlockMapW	create() Creates the single instance of IndexBlockMapW, and makes it available via i().
(package private) IndexBlock	getOrCreateIndexBlock(File transferandDocumentFile, int geneCount, IndexBlockMapW.KeySD keySD, ClipIndexEncoder clipIndexEncoder) Returns the index block for a particular sourceDocumentFile, creating a new one if necessary.
(package private) static IndexBlockMapW	i() The single instance of IndexBlockMapW.

Methods inherited from class IndexBlockMap

getIndexBlock

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

i

static IndexBlockMapW i()

The single instance of IndexBlockMapW.

create

static IndexBlockMapW create()
                      throws IOException

Creates the single instance of IndexBlockMapW, and makes it available via i().

Throws:

IOException

_createUnchecked

static IndexBlockMapW _createUnchecked()
                                throws IOException

Throws:

IOException

getOrCreateIndexBlock

IndexBlock getOrCreateIndexBlock(File transferandDocumentFile,
                                 int geneCount,
                                 IndexBlockMapW.KeySD keySD,
                                 ClipIndexEncoder clipIndexEncoder)
                           throws IOException

Returns the index block for a particular sourceDocumentFile, creating a new one if necessary. To save file storage space (in the document cache, used by the blocks) and to keep in-text clip indeces short, blocks are reused across multiple versions of a document.

Parameters:

transferandDocumentFile - designating a copy of the transferand source document

geneCount - of the document

keySD - specifying other key particulars of the document

Throws:

IOException