|
ModeShape Distribution 3.0.0.Beta2 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@ThreadSafe public interface BinaryStore
The basic interface for a store for Binary value objects. All binary values that are of a
minimum threshold size
are stored in the store; smaller binary values are kept in-memory
and are stored within the nodes.
Field Summary | |
---|---|
static long |
DEFAULT_MINIMUM_BINARY_SIZE_IN_BYTES
The default minimum size (in bytes) of binary values that are persisted in the binary store is 4096 bytes, or 4KB. |
Method Summary | |
---|---|
String |
getExtractedText(BinaryValue source)
Retrieves the extracted text of a binary value, which may or may not have been stored previously. |
InputStream |
getInputStream(BinaryKey key)
Get an InputStream to the binary content with the supplied key. |
String |
getMimeType(BinaryValue binary,
String name)
Get the MIME type for this binary value. |
long |
getMinimumBinarySizeInBytes()
Get the minimum number of bytes that a binary value must contain before it can be stored in the binary store. |
String |
getText(BinaryValue binary)
Get the text that can be extracted from this binary content. |
void |
markAsUnused(Iterable<BinaryKey> keys)
Mark the supplied binary keys as unused, but key them in quarantine until needed again (at which point they're removed from quarantine) or until removeValuesUnusedLongerThan(long, TimeUnit) is called. |
void |
removeValuesUnusedLongerThan(long minimumAge,
TimeUnit unit)
Remove binary values that have been unused for at least the specified amount of time. |
void |
setMimeTypeDetector(MimeTypeDetector mimeTypeDetector)
Set the MIME type detector that can be used for determining the MIME type for binary content. |
void |
setMinimumBinarySizeInBytes(long minSizeInBytes)
Set the minimum number of bytes that a binary value must contain before it can be stored in the binary store. |
void |
setTextExtractors(TextExtractors textExtractors)
Set the text extractor that can be used for extracting text from binary content. |
void |
storeExtractedText(BinaryValue source,
String extractedText)
Stores the extracted text of a binary value into this store. |
BinaryValue |
storeValue(InputStream stream)
Store the binary value and return the JCR representation. |
Field Detail |
---|
static final long DEFAULT_MINIMUM_BINARY_SIZE_IN_BYTES
Method Detail |
---|
long getMinimumBinarySizeInBytes()
void setMinimumBinarySizeInBytes(long minSizeInBytes)
minSizeInBytes
- the minimum number of bytes for a stored binary value; may not be negativevoid setTextExtractors(TextExtractors textExtractors)
textExtractors
- a non-null TextExtractors
instancevoid setMimeTypeDetector(MimeTypeDetector mimeTypeDetector)
mimeTypeDetector
- the detectorBinaryValue storeValue(InputStream stream) throws BinaryStoreException
stream
- the stream containing the binary content to be stored; may not be null
BinaryStoreException
InputStream getInputStream(BinaryKey key) throws BinaryStoreException
InputStream
to the binary content with the supplied key.
key
- the key to the binary content; never null
BinaryStoreException
- if there is a problem reading the content from the storevoid markAsUnused(Iterable<BinaryKey> keys) throws BinaryStoreException
removeValuesUnusedLongerThan(long, TimeUnit)
is called. This method ignores any keys for
values not stored within this store.
keys
- the keys for the binary values that are no longer needed
BinaryStoreException
- if there is a problem marking any of the supplied binary values as unusedvoid removeValuesUnusedLongerThan(long minimumAge, TimeUnit unit) throws BinaryStoreException
unused
for at least the specified amount of time.
minimumAge
- the minimum time that a binary value has been unused
before it can be
removed; must be non-negativeunit
- the time unit for the minimum age; may not be null
BinaryStoreException
- if there is a problem removing the unused valuesString getText(BinaryValue binary) throws BinaryStoreException
null
If extraction is enabled, this method may block until a text extractor has finished extracting the text.
binary
- the binary content; may not be null
BinaryStoreException
- if the binary content could not be accessedString getMimeType(BinaryValue binary, String name) throws IOException, RepositoryException
binary
- the binary content; may not be nullname
- the name of the content, useful for determining the MIME type; may be null if not known
IOException
- if there is a problem reading the binary content
RepositoryException
- if an error occurs.void storeExtractedText(BinaryValue source, String extractedText) throws BinaryStoreException
source
- a non-null
BinaryValue
instance from which the text was extractedextractedText
- a non-null
and non-blank
string representing the extracted text
BinaryStoreException
- if the operation fails for whatever reasonString getExtractedText(BinaryValue source) throws BinaryStoreException
source
- a non-null
BinaryValue
instance from which the text was extracted
String
representing the extracted text, or null
if such text hasn't been stored in this
store previously.
BinaryStoreException
- if the operation fails
|
ModeShape Distribution 3.0.0.Beta2 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |