blackboard.cms.metadata
Interface MetadataManager

public interface MetadataManager

MetadataManager

Since:

Bb Caliper 1.0

Version:

$Revision: #1 $ $Date: 2007/06/27 $

Nested Class Summary

static class

MetadataManager.Options

Field Summary

static java.lang.String

COLLISION

Method Summary

XythosMetadata	convertFromProperties(java.util.Properties props) Creates a XythosMetadata container based on the provide Properties object.
java.util.Properties	convertToProperties(java.util.List<XythosMetadata> mdList) Creates a Properties object mapping to metadata attributes.
java.util.Properties	convertToProperties(XythosMetadata mdObj) Creates a Properties object mapping to metadata attributes.
boolean	hasMetadata(blackboard.platform.forms.Form theForm, com.xythos.storageServer.api.FileSystemEntry fse) Returns flag denoting if any metadata for the associated entry is in use by the form.
XythosMetadata	load(com.xythos.storageServer.api.FileSystemEntry fse) Loads the metadata associated with the provided xythos entity.
XythosMetadata	load(com.xythos.storageServer.api.FileSystemEntry fse, com.xythos.security.api.Context ctx) Loads the metadata associated with the provided xythos entity.
XythosMetadata	load(java.lang.String xythosId) Loads the metadata associated with the provided xythos entity.
void	loadFromFile(com.xythos.storageServer.api.FileSystemEntry fse, java.io.File target) Persists metadata from file to FileSystemEntry
java.lang.String	loadProperty(java.lang.String xythosId, java.lang.String name) Return property as specified by provided name.
void	persistToFile(com.xythos.storageServer.api.FileSystemEntry fse, java.io.File target) Persists metadata associated with entry to file.
void	save(XythosMetadata md, com.xythos.storageServer.api.FileSystemDirectory fsd, MetadataManager.Options option) Updates/saves the metadata for the provided xythos entity.
void	save(XythosMetadata md, com.xythos.storageServer.api.FileSystemEntry fse) Updates/saves the metadata for the provided xythos entity.
void	save(XythosMetadata md, java.lang.String xythosId) Updates/saves the metadata for the provided xythos entity.
void	save(XythosMetadata md, java.lang.String xythosId, MetadataManager.Options option) Updates/saves the metadata for the provided xythos entity.
void	saveProperty(java.lang.String xythosId, java.lang.String name, java.lang.String propValue) Persists specified property.

Field Detail

COLLISION

static final java.lang.String COLLISION

See Also:

Constant Field Values

Method Detail

load

XythosMetadata load(com.xythos.storageServer.api.FileSystemEntry fse)
                    throws blackboard.persist.PersistenceException

Loads the metadata associated with the provided xythos entity.

Parameters:

fse -

Returns:

Throws:

com.xythos.common.api.XythosException

blackboard.persist.PersistenceException

load

XythosMetadata load(com.xythos.storageServer.api.FileSystemEntry fse,
                    com.xythos.security.api.Context ctx)
                    throws blackboard.persist.PersistenceException

Loads the metadata associated with the provided xythos entity.

Parameters:

fse -

ctx -

Returns:

Throws:

com.xythos.common.api.XythosException

blackboard.persist.PersistenceException

convertFromProperties

XythosMetadata convertFromProperties(java.util.Properties props)
                                     throws blackboard.persist.PersistenceException

Creates a XythosMetadata container based on the provide Properties object. Used to handle transformation of string bindings from Xythos xml queries.

Parameters:

fse -

Returns:

Throws:

com.xythos.common.api.XythosException

blackboard.persist.PersistenceException

convertToProperties

java.util.Properties convertToProperties(XythosMetadata mdObj)

Creates a Properties object mapping to metadata attributes.

Parameters:

mdObj -

Returns:

Throws:

blackboard.persist.PersistenceException

convertToProperties

java.util.Properties convertToProperties(java.util.List<XythosMetadata> mdList)

Creates a Properties object mapping to metadata attributes.

Parameters:

mdObj -

Returns:

Throws:

blackboard.persist.PersistenceException

load

XythosMetadata load(java.lang.String xythosId)
                    throws blackboard.persist.KeyNotFoundException,
                           blackboard.persist.PersistenceException

Loads the metadata associated with the provided xythos entity. The xythos id is used to uniquely identify the corresponding xythos entity.

Parameters:

xythosId -

Returns:

Throws:

blackboard.persist.KeyNotFoundException

com.xythos.common.api.XythosException

blackboard.persist.PersistenceException

loadFromFile

void loadFromFile(com.xythos.storageServer.api.FileSystemEntry fse,
                  java.io.File target)
                  throws blackboard.persist.PersistenceException

Persists metadata from file to FileSystemEntry

Parameters:

fse -

target -

Throws:

blackboard.persist.PersistenceException

persistToFile

void persistToFile(com.xythos.storageServer.api.FileSystemEntry fse,
                   java.io.File target)
                   throws blackboard.persist.PersistenceException

Persists metadata associated with entry to file.

Parameters:

fse -

target -

Throws:

blackboard.persist.PersistenceException

save

void save(XythosMetadata md,
          com.xythos.storageServer.api.FileSystemEntry fse)
          throws blackboard.persist.PersistenceException

Updates/saves the metadata for the provided xythos entity.

Parameters:

md -

fse -

Throws:

com.xythos.common.api.XythosException

blackboard.persist.PersistenceException

save

void save(XythosMetadata md,
          com.xythos.storageServer.api.FileSystemDirectory fsd,
          MetadataManager.Options option)
          throws blackboard.persist.PersistenceException

Updates/saves the metadata for the provided xythos entity. Can updated all nested information if recursive flag is set.

Parameters:

md -

fse -

bRecursive -

Throws:

com.xythos.common.api.XythosException

blackboard.persist.PersistenceException

save

void save(XythosMetadata md,
          java.lang.String xythosId)
          throws blackboard.persist.KeyNotFoundException,
                 blackboard.persist.PersistenceException

Updates/saves the metadata for the provided xythos entity. The xythos id is used to uniquely identify the corresponding xythos entity.

Parameters:

md -

xythosId -

Throws:

blackboard.persist.KeyNotFoundException

com.xythos.common.api.XythosException

blackboard.persist.PersistenceException

save

void save(XythosMetadata md,
          java.lang.String xythosId,
          MetadataManager.Options option)
          throws blackboard.persist.KeyNotFoundException,
                 blackboard.persist.PersistenceException

Updates/saves the metadata for the provided xythos entity. The xythos id is used to uniquely identify the corresponding xythos entity. Can updated all nested information if recursive flag is set. If the path provided is a directory.

Parameters:

md -

xythosId -

Throws:

blackboard.persist.KeyNotFoundException

com.xythos.common.api.XythosException

blackboard.persist.PersistenceException

loadProperty

java.lang.String loadProperty(java.lang.String xythosId,
                              java.lang.String name)
                              throws blackboard.persist.KeyNotFoundException,
                                     blackboard.persist.PersistenceException

Return property as specified by provided name.

Parameters:

xythosId -

name -

Returns:

Throws:

blackboard.persist.KeyNotFoundException

blackboard.persist.PersistenceException

saveProperty

void saveProperty(java.lang.String xythosId,
                  java.lang.String name,
                  java.lang.String propValue)
                  throws blackboard.persist.KeyNotFoundException,
                         blackboard.persist.PersistenceException

Persists specified property.

Parameters:

xythosId -

name -

propValue -

Throws:

blackboard.persist.KeyNotFoundException

blackboard.persist.PersistenceException

hasMetadata

boolean hasMetadata(blackboard.platform.forms.Form theForm,
                    com.xythos.storageServer.api.FileSystemEntry fse)
                    throws blackboard.persist.PersistenceException

Returns flag denoting if any metadata for the associated entry is in use by the form.

Parameters:

theForm -

fse -

Returns:

Throws:

blackboard.persist.PersistenceException