com.solarmetric.rd.kodo.impl.jdbc.meta
Class MappingRepository

java.lang.Object
  |
  +--com.solarmetric.rd.kodo.impl.jdbc.meta.MappingRepository

All Implemented Interfaces:

java.util.EventListener, JDOMetaDataRepository, javax.jdo.spi.RegisterClassListener

public class MappingRepository

extends java.lang.Object

implements JDOMetaDataRepository

Repository of class mapping information. The repository uses an internal JDOMetaDataRepository to track metadata.

Constructor Summary

MappingRepository(com.solarmetric.rd.kodo.impl.jdbc.conf.JDBCConfiguration conf)
Constructor.

Method Summary

void	addMetaData(com.solarmetric.rd.kodo.meta.ClassMetaData meta) Add a metadata instance to the repository.
void	clear() Clear the cache of parsed metadata.
com.solarmetric.rd.kodo.conf.JDOConfiguration	getConfiguration() Return the configuration supplied on construction.
com.solarmetric.rd.kodo.meta.ClassMetaData	getEmbeddedMetaData(com.solarmetric.rd.kodo.meta.ClassMetaData owner, int field) Return the class metadata for the embedded value of the given field.
com.solarmetric.rd.kodo.meta.JDOMetaDataGenerator	getGenerator() Return the generator to use to create default metadata.
org.apache.commons.logging.Log	getLog() Return the log to use for messages.
com.solarmetric.rd.kodo.impl.jdbc.meta.ClassMapping	getMapping(java.lang.Class cls, java.lang.ClassLoader loader, boolean validate) Convenience method to make casting from getMetaData(Class,ClassLoader,boolean) unnecessary.
com.solarmetric.rd.kodo.meta.ClassMetaData	getMapping(com.solarmetric.rd.kodo.meta.ClassMetaData meta, boolean validate) Returns the requested mapping after generating and caching it if necessary.
com.solarmetric.rd.kodo.impl.jdbc.meta.ClassMapping	getMapping(java.lang.Object oid, java.lang.ClassLoader loader, boolean validate) Convenience method to make casting from #getMetaData(Object,boolean) unnecessary.
com.solarmetric.rd.kodo.impl.jdbc.meta.MappingInfoRepository	getMappingInfoRepository() Return the system mappings.
com.solarmetric.rd.kodo.impl.jdbc.meta.MappingProvider	getMappingProvider() Return the mapping provider.
com.solarmetric.rd.kodo.impl.jdbc.meta.ClassMapping[]	getMappings() Convenience method to make casting from getMetaDatas() unnecessary.
com.solarmetric.rd.kodo.meta.ClassMetaData	getMetaData(java.lang.Class cls, java.lang.ClassLoader loader, boolean validate) Return the metadata for the given class.
com.solarmetric.rd.kodo.meta.ClassMetaData	getMetaData(java.lang.Object oid, java.lang.ClassLoader loader, boolean validate) Return the least-derived class metadata for the given oid.
com.solarmetric.rd.kodo.meta.JDOMetaDataRepository	getMetaDataRepository() Return the metadata repository used internally.
com.solarmetric.rd.kodo.meta.ClassMetaData[]	getMetaDatas() Return all the metadata instances currently in the repository.
com.solarmetric.rd.kodo.meta.JDOMetaDataParser	getParser() Return the parser to use to parse jdo metadata files.
com.solarmetric.rd.kodo.impl.jdbc.schema.SchemaGroup	getSchemaGroup() Return the runtime schema.
boolean	hasMetaData(java.lang.Class cls) Return true if the repository has metadata for the given class.
void	registerClass(javax.jdo.spi.RegisterClassEvent ev)
boolean	removeMetaData(java.lang.Class cls) Remove a metadata instance from the repository.
boolean	removeMetaData(com.solarmetric.rd.kodo.meta.ClassMetaData meta) Remove a metadata instance from the repository.
void	setGenerator(com.solarmetric.rd.kodo.meta.JDOMetaDataGenerator generator) Set the generator to use to create default metadata.
void	setMappingInfoRepository(com.solarmetric.rd.kodo.impl.jdbc.meta.MappingInfoRepository repos) Set the system mappings.
void	setMappingProvider(com.solarmetric.rd.kodo.impl.jdbc.meta.MappingProvider provider) Set the mapping provider to use.
void	setMetaDataRepository(com.solarmetric.rd.kodo.meta.JDOMetaDataRepository repos) Set the metadata repository used internally.
void	setParser(com.solarmetric.rd.kodo.meta.JDOMetaDataParser parser) Set the parser to use to parse jdo metadata files.
void	setSchemaGroup(com.solarmetric.rd.kodo.impl.jdbc.schema.SchemaGroup schema) Set the runtime schema.

Methods inherited from class java.lang.Object

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

Constructor Detail

MappingRepository

public MappingRepository(com.solarmetric.rd.kodo.impl.jdbc.conf.JDBCConfiguration conf)

Constructor. Supply configuration.

Method Detail

getConfiguration

public com.solarmetric.rd.kodo.conf.JDOConfiguration getConfiguration()

Return the configuration supplied on construction.

Specified by:

getConfiguration in interface JDOMetaDataRepository

getLog

public org.apache.commons.logging.Log getLog()

Return the log to use for messages.

getSchemaGroup

public com.solarmetric.rd.kodo.impl.jdbc.schema.SchemaGroup getSchemaGroup()

Return the runtime schema. If no schema has been explicitly set, the current SchemaFactory is asked to read the schema.

setSchemaGroup

public void setSchemaGroup(com.solarmetric.rd.kodo.impl.jdbc.schema.SchemaGroup schema)

Set the runtime schema.

getMappingInfoRepository

public com.solarmetric.rd.kodo.impl.jdbc.meta.MappingInfoRepository getMappingInfoRepository()

Return the system mappings.

setMappingInfoRepository

public void setMappingInfoRepository(com.solarmetric.rd.kodo.impl.jdbc.meta.MappingInfoRepository repos)

Set the system mappings.

getMetaDataRepository

public com.solarmetric.rd.kodo.meta.JDOMetaDataRepository getMetaDataRepository()

Return the metadata repository used internally.

setMetaDataRepository

public void setMetaDataRepository(com.solarmetric.rd.kodo.meta.JDOMetaDataRepository repos)

Set the metadata repository used internally.

getMappingProvider

public com.solarmetric.rd.kodo.impl.jdbc.meta.MappingProvider getMappingProvider()

Return the mapping provider.

setMappingProvider

public void setMappingProvider(com.solarmetric.rd.kodo.impl.jdbc.meta.MappingProvider provider)

Set the mapping provider to use.

getParser

public com.solarmetric.rd.kodo.meta.JDOMetaDataParser getParser()

Description copied from interface: JDOMetaDataRepository

Return the parser to use to parse jdo metadata files. Defaults to a standard JDOMetaDataParser.

Specified by:

getParser in interface JDOMetaDataRepository

setParser

public void setParser(com.solarmetric.rd.kodo.meta.JDOMetaDataParser parser)

Description copied from interface: JDOMetaDataRepository

Set the parser to use to parse jdo metadata files. Defaults to a standard JDOMetaDataParser.

Specified by:

setParser in interface JDOMetaDataRepository

getGenerator

public com.solarmetric.rd.kodo.meta.JDOMetaDataGenerator getGenerator()

Description copied from interface: JDOMetaDataRepository

Return the generator to use to create default metadata. Defaults to a standard JDOMetaDataGenerator.

Specified by:

getGenerator in interface JDOMetaDataRepository

setGenerator

public void setGenerator(com.solarmetric.rd.kodo.meta.JDOMetaDataGenerator generator)

Description copied from interface: JDOMetaDataRepository

Set the generator to use to create default metadata. Defaults to a standard JDOMetaDataGenerator.

Specified by:

setGenerator in interface JDOMetaDataRepository

getMetaData

public com.solarmetric.rd.kodo.meta.ClassMetaData getMetaData(java.lang.Class cls,
                                                              java.lang.ClassLoader loader,
                                                              boolean validate)

Description copied from interface: JDOMetaDataRepository

Return the metadata for the given class.

Specified by:

getMetaData in interface JDOMetaDataRepository

Parameters:

cls - the class to retrieve metadata for

loader - the persistence manager's class loader, if any

validate - if true, throws a JDOMetaDataNotFoundException if no metadat is found

getMapping

public com.solarmetric.rd.kodo.impl.jdbc.meta.ClassMapping getMapping(java.lang.Class cls,
                                                                      java.lang.ClassLoader loader,
                                                                      boolean validate)

Convenience method to make casting from getMetaData(Class,ClassLoader,boolean) unnecessary.

getEmbeddedMetaData

public com.solarmetric.rd.kodo.meta.ClassMetaData getEmbeddedMetaData(com.solarmetric.rd.kodo.meta.ClassMetaData owner,
                                                                      int field)

Description copied from interface: JDOMetaDataRepository

Return the class metadata for the embedded value of the given field.

Specified by:

getEmbeddedMetaData in interface JDOMetaDataRepository

getMetaDatas

public com.solarmetric.rd.kodo.meta.ClassMetaData[] getMetaDatas()

Description copied from interface: JDOMetaDataRepository

Return all the metadata instances currently in the repository.

Specified by:

getMetaDatas in interface JDOMetaDataRepository

getMappings

public com.solarmetric.rd.kodo.impl.jdbc.meta.ClassMapping[] getMappings()

Convenience method to make casting from getMetaDatas() unnecessary.

hasMetaData

public boolean hasMetaData(java.lang.Class cls)

Description copied from interface: JDOMetaDataRepository

Return true if the repository has metadata for the given class.

Specified by:

hasMetaData in interface JDOMetaDataRepository

addMetaData

public void addMetaData(com.solarmetric.rd.kodo.meta.ClassMetaData meta)

Description copied from interface: JDOMetaDataRepository

Add a metadata instance to the repository.

Specified by:

addMetaData in interface JDOMetaDataRepository

removeMetaData

public boolean removeMetaData(com.solarmetric.rd.kodo.meta.ClassMetaData meta)

Description copied from interface: JDOMetaDataRepository

Remove a metadata instance from the repository.

Specified by:

removeMetaData in interface JDOMetaDataRepository

Returns:

true if removed, false if not in this repository

removeMetaData

public boolean removeMetaData(java.lang.Class cls)

Description copied from interface: JDOMetaDataRepository

Remove a metadata instance from the repository.

Specified by:

removeMetaData in interface JDOMetaDataRepository

Returns:

true if removed, false if not in this repository

getMetaData

public com.solarmetric.rd.kodo.meta.ClassMetaData getMetaData(java.lang.Object oid,
                                                              java.lang.ClassLoader loader,
                                                              boolean validate)

Description copied from interface: JDOMetaDataRepository

Return the least-derived class metadata for the given oid.

Specified by:

getMetaData in interface JDOMetaDataRepository

Parameters:

oid - the oid to get the metadata for

loader - the persistence manager's class loader, if any

validate - if true, throws a JDOMetaDataNotFoundException if no metadat is found

getMapping

public com.solarmetric.rd.kodo.impl.jdbc.meta.ClassMapping getMapping(java.lang.Object oid,
                                                                      java.lang.ClassLoader loader,
                                                                      boolean validate)

Convenience method to make casting from #getMetaData(Object,boolean) unnecessary.

getMapping

public com.solarmetric.rd.kodo.meta.ClassMetaData getMapping(com.solarmetric.rd.kodo.meta.ClassMetaData meta,
                                                             boolean validate)

Returns the requested mapping after generating and caching it if necessary. If the validate is true, throws a MappingInfoNotFoundException if no mapping exists.

clear

public void clear()

Description copied from interface: JDOMetaDataRepository

Clear the cache of parsed metadata. This method also clears the internal parser's cache of parsed files.

Specified by:

clear in interface JDOMetaDataRepository

registerClass

public void registerClass(javax.jdo.spi.RegisterClassEvent ev)

Specified by:

registerClass in interface javax.jdo.spi.RegisterClassListener