org.gvsig.metadata.lib.basic.impl

Class AbstractMetadataManager

java.lang.Object

org.gvsig.metadata.lib.basic.impl.AbstractMetadataManager

All Implemented Interfaces:

MetadataManager

Direct Known Subclasses:

BasicMetadataManager

public abstract class AbstractMetadataManager
extends java.lang.Object
implements MetadataManager

Abstract metadata manager used in both metadata basic and full modules.

Field Summary

Fields

Modifier and Type	Field and Description
protected DynObjectManager	dynManager
protected java.io.File	metadataHomeFile

Fields inherited from interface org.gvsig.metadata.MetadataManager

METADATA_NAMESPACE

Constructor Summary

Constructors

Constructor and Description
AbstractMetadataManager()

Method Summary

Modifier and Type	Method and Description
void	addDefinition(DynClass definition) Adds a new definition in the metadata manager.
DynStruct	addDefinition(java.lang.String metadataDefinitionName, java.io.InputStream stream, java.lang.ClassLoader loader) Adds a new definition in the metadata manager.
DynStruct	addDefinition(java.lang.String name, java.lang.String description) Adds a new definition in the metadata manager.
protected abstract Metadata	createMetadata(DynStruct definition)
protected abstract MetadataContainer	createMetadataContainer(DynClass dynClass)
MetadataContainer	createMetadataContainer(java.lang.String name) This is a utility interface to implement classes that implement the interface Metadata.
DynStruct	getDefinition(Metadata metadata) If a Metadata definition ( DynStruct ) with a given metadata that has been previously registered in this manager, then this method returns that definition.
DynStruct	getDefinition(java.lang.String metadataName) If a Metadata definition ( DynStruct ) with the given definition name has been previously registered in this manager, then this method returns that definition.
java.util.Iterator	getDefinitions() Retrieves all the current definitions in the form of an Iterator interface.
Metadata	getMetadata(DynStruct definition) Creates a default Metadata instance based on a given DynStruct, if it has not been previously registered, and adds this Metadata to the system.
Metadata	getMetadata(java.lang.String metadataID) Retrieves a metadata object based on its metadata ID.
java.io.File	getMetadataHomeRepository() Returns the main Metadata extension root repository.
java.io.File	getRepositoryFile(java.lang.String relativePath)
boolean	getValidationBeforeExporting() Added options properties getter for validating before the exporting function.
boolean	getValidationBeforeSaving() Added options properties getter for validating before the saving function.
protected void	initDefinitions()
void	loadMetadata(Metadata metadata) This function populates the given Metadata object with the current values that the system contains.
void	removeDefinition(DynStruct dynStruct) If the current dynStruct has been previously registered, it is removed from both the dynObjectManager and the metadataManager lists.
void	setMetadataHomeRepository(java.io.File metadataHomeFile) Sets the main Metadata root repository for this manager.
void	setValidationBeforeExporting(boolean doValidation) Added options properties setter for validating before the exporting function.
void	setValidationBeforeSaving(boolean doValidation) Added options properties setter for validating before the saving function.
void	storeDefinitions()
void	storeMetadata(Metadata metadata) This function stores the given Metadata object to an output resource, be it a database or a file containing its information.

Methods inherited from class java.lang.Object

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

Field Detail

dynManager

protected DynObjectManager dynManager

metadataHomeFile

protected java.io.File metadataHomeFile

Constructor Detail

AbstractMetadataManager

public AbstractMetadataManager()

Method Detail

initDefinitions

protected void initDefinitions()

addDefinition

public DynStruct addDefinition(java.lang.String name,
                               java.lang.String description)
                        throws MetadataException

Description copied from interface: MetadataManager

Adds a new definition in the metadata manager. The new definition is defined in the namespace by default for DynClasses used for metadata.

Specified by:

addDefinition in interface MetadataManager

Parameters:

name - the definition Name

description - the definition Description

Returns:

the created DynStruct definition

Throws:

MetadataException

addDefinition

public DynStruct addDefinition(java.lang.String metadataDefinitionName,
                               java.io.InputStream stream,
                               java.lang.ClassLoader loader)
                        throws MetadataException

Description copied from interface: MetadataManager

Adds a new definition in the metadata manager. The new definition is defined in the namespace by default for DynClasses used for metadata.

Specified by:

addDefinition in interface MetadataManager

Parameters:

metadataDefinitionName - the definition Name

stream - the input stream to be parsed.

loader - the Class loader that can parse this input stream

Returns:

the created DynStruct definition

Throws:

MetadataException

getDefinition

public DynStruct getDefinition(Metadata metadata)
                        throws MetadataException

Description copied from interface: MetadataManager

If a Metadata definition ( DynStruct ) with a given metadata that has been previously registered in this manager, then this method returns that definition. Otherwise, it returns null.

Specified by:

getDefinition in interface MetadataManager

Parameters:

metadata - the given metadata.

Returns:

The attribute definition corresponding to the provided metadata class, or null otherwise.

Throws:

MetadataException

getDefinition

public DynStruct getDefinition(java.lang.String metadataName)

Description copied from interface: MetadataManager

If a Metadata definition ( DynStruct ) with the given definition name has been previously registered in this manager, then this method returns that definition. Otherwise, it returns null.

Specified by:

getDefinition in interface MetadataManager

Parameters:

metadataName - the name whose corresponding attribute definition is to be retrieved.

Returns:

The attribute definition corresponding to the provided metadata class, or null otherwise.

addDefinition

public void addDefinition(DynClass definition)
                   throws MetadataException

Description copied from interface: MetadataManager

Adds a new definition in the metadata manager. The new definition is defined in the namespace by default for DynClasses used for metadata.

Specified by:

addDefinition in interface MetadataManager

Throws:

MetadataException

removeDefinition

public void removeDefinition(DynStruct dynStruct)

Description copied from interface: MetadataManager

If the current dynStruct has been previously registered, it is removed from both the dynObjectManager and the metadataManager lists. Otherwise, does nothing.

Specified by:

removeDefinition in interface MetadataManager

Parameters:

dynStruct - the dynStruct to be removed.

createMetadataContainer

public MetadataContainer createMetadataContainer(java.lang.String name)

Description copied from interface: MetadataManager

This is a utility interface to implement classes that implement the interface Metadata. Use the createMetadataContainer in the MetadataManager to create a container for delegate the implementation of Metadata methods in it.

Specified by:

createMetadataContainer in interface MetadataManager

Parameters:

name - the DynStruct name.

Returns:

the metadata container.

createMetadataContainer

protected abstract MetadataContainer createMetadataContainer(DynClass dynClass)

storeMetadata

public void storeMetadata(Metadata metadata)
                   throws MetadataException

Description copied from interface: MetadataManager

This function stores the given Metadata object to an output resource, be it a database or a file containing its information.

Specified by:

storeMetadata in interface MetadataManager

Parameters:

metadata - the metadata that needs to be stored.

Throws:

MetadataException - Exception caused by any access violation.

loadMetadata

public void loadMetadata(Metadata metadata)
                  throws MetadataException

Description copied from interface: MetadataManager

This function populates the given Metadata object with the current values that the system contains. If there is any invalid access to an undeclared field, for example, a MetadataException will be thrown.

Specified by:

loadMetadata in interface MetadataManager

Parameters:

metadata - the metadata that needs to be populated.

Throws:

MetadataException - Exception caused by any access violation.

getMetadata

public Metadata getMetadata(DynStruct definition)
                     throws InvalidMetadataNamespaceException

Description copied from interface: MetadataManager

Creates a default Metadata instance based on a given DynStruct, if it has not been previously registered, and adds this Metadata to the system.

Specified by:

getMetadata in interface MetadataManager

Parameters:

definition - the given dynStruct object.

Returns:

the resultant Metadata object.

Throws:

InvalidMetadataNamespaceException

createMetadata

protected abstract Metadata createMetadata(DynStruct definition)

getMetadataHomeRepository

public java.io.File getMetadataHomeRepository()

Description copied from interface: MetadataManager

Returns the main Metadata extension root repository.

Specified by:

getMetadataHomeRepository in interface MetadataManager

Returns:

the File object containing the home repository folder

getRepositoryFile

public java.io.File getRepositoryFile(java.lang.String relativePath)

storeDefinitions

public void storeDefinitions()

getDefinitions

public java.util.Iterator getDefinitions()

Description copied from interface: MetadataManager

Retrieves all the current definitions in the form of an Iterator interface.

Specified by:

getDefinitions in interface MetadataManager

Returns:

The Metadata iterator containing the current metadata definitions

setMetadataHomeRepository

public void setMetadataHomeRepository(java.io.File metadataHomeFile)

Description copied from interface: MetadataManager

Sets the main Metadata root repository for this manager.

Specified by:

setMetadataHomeRepository in interface MetadataManager

Parameters:

metadataHomeFile - the main Repository folder.

getMetadata

public Metadata getMetadata(java.lang.String metadataID)
                     throws InvalidMetadataNamespaceException

Description copied from interface: MetadataManager

Retrieves a metadata object based on its metadata ID. This metadata object is basically a dynObject if metadata namespace set to "metadata".

Specified by:

getMetadata in interface MetadataManager

Parameters:

metadataID - the metadata ID of the metadata object.

Returns:

Throws:

InvalidMetadataNamespaceException - if the metadataID was not previously registered as Metadata.

setValidationBeforeSaving

public void setValidationBeforeSaving(boolean doValidation)

Description copied from interface: MetadataManager

Added options properties setter for validating before the saving function. If it is set to false, the validation will not be performed.

Specified by:

setValidationBeforeSaving in interface MetadataManager

Parameters:

doValidation - if the validation must be performed or not before saving metadata objects.

getValidationBeforeSaving

public boolean getValidationBeforeSaving()

Description copied from interface: MetadataManager

Added options properties getter for validating before the saving function. If it is set to false, the validation will not be performed.

Specified by:

getValidationBeforeSaving in interface MetadataManager

Returns:

if the validation must be performed or not before saving metadata objects.

setValidationBeforeExporting

public void setValidationBeforeExporting(boolean doValidation)

Description copied from interface: MetadataManager

Added options properties setter for validating before the exporting function. If it is set to false, the validation will not be performed.

Specified by:

setValidationBeforeExporting in interface MetadataManager

Parameters:

doValidation - if the validation must be performed or not before saving metadata objects.

getValidationBeforeExporting

public boolean getValidationBeforeExporting()

Description copied from interface: MetadataManager

Added options properties getter for validating before the exporting function. If it is set to false, the validation will not be performed.

Specified by:

getValidationBeforeExporting in interface MetadataManager

Returns:

if the validation must be performed or not before saving metadata objects.