com.logicaldoc.core.store

Interface Storer

All Known Implementing Classes:

FSStorer

public interface Storer

The Storer manages the repository where document files are maintained and all general resources are stored.

Author:

Michael Scholz, Marco Meschieri

Method Summary

Methods

Modifier and Type	Method and Description
void	delete(long docId) Deletes all resources of a document from the storage.
void	delete(long docId, String resource) Deletes a specific resource of a document from the storage.
boolean	exists(long docId, String resource) Checks if the passed resource exists in the document's container
byte[]	getBytes(long docId, String resource) Obtains the document's raw bytes for the specified version
String	getResourceName(Document doc, String fileVersion, String suffix) Computes the resource name inside the container
String	getResourceName(long docId, String fileVersion, String suffix) Computes the resource name inside the container
InputStream	getStream(long docId, String resource) Obtains the document's content for the specified version
long	getTotalSize() Computes the total size of the documents repository(in bytes)
List<String>	listResources(long docId, String fileVersion) Lists all resources in the document's container
long	size(long docId, String resource) Computed the size of a specific resource.
long	store(File file, long docId, String resource)
long	store(InputStream stream, long docId, String resource) This method has to store a resource in the document's container.
void	writeTo(long docId, String resource, File out) Writes the specified resource in a file

Method Detail

store

long store(InputStream stream,
         long docId,
         String resource)

This method has to store a resource in the document's container. The location where (DBMS, Filesystem, other) the document should be stored is defined by the concrete implementation. It is possible to store a new document or a new version of an existing document.

Parameters:

stream - Document as InputStream

docId - The document identifier

resource - Name of the resource to be stored

Returns:

Size of the stored resource, or < 0 if the storage was not possible

store

long store(File file,
         long docId,
         String resource)

See Also:

store(InputStream stream, long docId, String resource)

delete

void delete(long docId)

Deletes all resources of a document from the storage.

Parameters:

docId - The document identifier

delete

void delete(long docId,
          String resource)

Deletes a specific resource of a document from the storage.

Parameters:

docId - The document identifier

resource - Name of the resource to be deleted

getResourceName

String getResourceName(Document doc,
                     String fileVersion,
                     String suffix)

Computes the resource name inside the container

Parameters:

doc - The document representation

fileVersion - The file version (use null for the latest version)

suffix - The file suffix (use null if you want the exact document file)

Returns:

The document's resource name

getResourceName

String getResourceName(long docId,
                     String fileVersion,
                     String suffix)

Computes the resource name inside the container

Parameters:

docId - The document identifier

fileVersion - The file version (use null for the latest version)

suffix - The file suffix (use null if you want the exact document file)

Returns:

The document's resource name

listResources

List<String> listResources(long docId,
                         String fileVersion)

Lists all resources in the document's container

Parameters:

docId - The document's identifier

fileVersion - If specified, lists the resources for that specific file version only

Returns:

size

long size(long docId,
        String resource)

Computed the size of a specific resource.

Parameters:

docId - The document's identifier

resource - The resource

Returns:

the size in bytes

exists

boolean exists(long docId,
             String resource)

Checks if the passed resource exists in the document's container

Parameters:

docId - ID of the document

resource - Name of the resource

Returns:

true only if the resource already exists

writeTo

void writeTo(long docId,
           String resource,
           File out)

Writes the specified resource in a file

Parameters:

docId - The document identifier

resource - Name of the resource

file - File that will receive the resource's content

getStream

InputStream getStream(long docId,
                    String resource)

Obtains the document's content for the specified version

Parameters:

docId - The document's identifier

resource - Name of the resource

Returns:

The document file's content

getBytes

byte[] getBytes(long docId,
              String resource)

Obtains the document's raw bytes for the specified version

Parameters:

docId - The document's identifier

resource - Name of the resource

Returns:

The document file's bytes

getTotalSize

long getTotalSize()

Computes the total size of the documents repository(in bytes)