com.bigdata.bfs

Interface DocumentHeader

All Known Subinterfaces:

Document

All Known Implementing Classes:

DocumentHeaderImpl, DocumentImpl, RepositoryDocumentImpl

public interface DocumentHeader

Document header interface for Documents stored in the IContentRepository.

Version:

$Id$

Author:

mike@systap.com

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,Object>	asMap() Returns a read-only view of the document metadata.
boolean	exists() Return true iff a version of the file existed at the time that this view was constructed.
String	getContentEncoding() The character set encoding that MUST be used to interpret the byte[] returned by Document#getContent().
String	getContentType() The MIME type for the document.
long	getEarliestVersionCreateTime() The time at which the earliest version of this file still on record was created (historical file metadata can be eradicated through compacting merges).
String	getId() The unique identifier for the document within the IContentRepository.
long	getMetadataUpdateTime() The time at which the metadata for the current version of this file was last updated.
Object	getProperty(String name) Get an arbitrary property value.
int	getVersion() Return the version identifier.
long	getVersionCreateTime() The time at which the current version of this file was created.

Method Detail

getId

String getId()

The unique identifier for the document within the IContentRepository.

getContentType

String getContentType()

The MIME type for the document.

getContentEncoding

String getContentEncoding()

The character set encoding that MUST be used to interpret the byte[] returned by Document#getContent().

getProperty

Object getProperty(String name)

Get an arbitrary property value.

Parameters:

property - The property name.

Returns:

The value.

asMap

Map<String,Object> asMap()

Returns a read-only view of the document metadata.

exists

boolean exists()

Return true iff a version of the file existed at the time that this view was constructed.

getVersion

int getVersion()

Return the version identifier.

Throws:

IllegalStateException - unless a version of the file existed at the time that this view was constructed.

getEarliestVersionCreateTime

long getEarliestVersionCreateTime()

The time at which the earliest version of this file still on record was created (historical file metadata can be eradicated through compacting merges).

getVersionCreateTime

long getVersionCreateTime()

The time at which the current version of this file was created.

Throws:

IllegalStateException - unless a version of the file existed at the time that this view was constructed.

getMetadataUpdateTime

long getMetadataUpdateTime()

The time at which the metadata for the current version of this file was last updated.

Throws:

IllegalStateException - unless a version of the file existed at the time that this view was constructed.