com.solarmetric.rd.kodo.meta
Interface JDOMetaDataRepository

All Superinterfaces:

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

All Known Implementing Classes:

JDOMetaDataRepositoryImpl, MappingRepository

public interface JDOMetaDataRepository

extends javax.jdo.spi.RegisterClassListener

Repository of JDO metadata.

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 for the repository.
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.
com.solarmetric.rd.kodo.meta.ClassMetaData	getMetaData(java.lang.Class cls, java.lang.ClassLoader pmLoader, boolean validate) Return the metadata for the given class.
com.solarmetric.rd.kodo.meta.ClassMetaData	getMetaData(java.lang.Object oid, java.lang.ClassLoader pmLoader, boolean validate) Return the least-derived class metadata for the given oid.
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.
boolean	hasMetaData(java.lang.Class cls) Return true if the repository has metadata for the given class.
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	setParser(com.solarmetric.rd.kodo.meta.JDOMetaDataParser parser) Set the parser to use to parse jdo metadata files.

Methods inherited from interface javax.jdo.spi.RegisterClassListener

registerClass

Method Detail

getConfiguration

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

Return the configuration for the repository.

getParser

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

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

setParser

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

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

getGenerator

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

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

setGenerator

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

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

getMetaData

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

Return the metadata for the given class.

Parameters:

cls - the class to retrieve metadata for

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

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

getEmbeddedMetaData

public 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.

getMetaDatas

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

Return all the metadata instances currently in the repository.

hasMetaData

public boolean hasMetaData(java.lang.Class cls)

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

addMetaData

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

Add a metadata instance to the repository.

removeMetaData

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

Remove a metadata instance from the repository.

Returns:

true if removed, false if not in this repository

removeMetaData

public boolean removeMetaData(java.lang.Class cls)

Remove a metadata instance from the repository.

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 pmLoader,
                                                              boolean validate)

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

Parameters:

oid - the oid to get the metadata for

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

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

clear

public void clear()

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