com.solarmetric.kodo.impl.jdbc.ormapping
Class MetaDataVerifier

java.lang.Object
  |
  +--com.solarmetric.kodo.impl.jdbc.ormapping.MetaDataVerifier

public class MetaDataVerifier

extends Object

Verifies that metadata for persistence capable types is consistent with the capabilities of the O/R mapping layer. The generic JDO subsystem can handle the full JDO specification, but the JDBC O/R layer cannot yet map the full range of Java objects. As the capabilities of the O/R layer are enhanced, this class should be trimmed to reflect them.

Inner Class Summary

static class

MetaDataVerifier.Msg Represents a message to the user about the metadata verification.

Constructor Summary

MetaDataVerifier(Configuration conf, ClassMetaData meta)
Constructor.

Method Summary

void	clearMessages() Clears the messages that have been accumulated from the verification thus far.
MetaDataVerifier.Msg[]	getMessages() Returns the accumulated messages from the verification that has been performed thus far.
static void	main(String[] args) Usage: java com.solarmetric.kodo.impl.jdbc.MetaDataVerifier [class name | .class file | .jdo file]+
static void	main(String[] args, PrintStream out)
void	verifyAll() Verifies the given metadata against he current capabilities of the O/R layer.
void	verifyFields() Checks that field types are persistable.
void	verifyImplicitPersistence() Checks that the field meta datas are not being implicitly set to persistent, possibly causing unexpected serialization behavior.
void	verifyPrimaryKeys() Warns if the user has specified primary key fields that are not persistable as simple value mappings.
void	verifySuperclass() Warns if the described type has a persistence-capable superclass but does not appear to specify it in the metadata.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetaDataVerifier

public MetaDataVerifier(Configuration conf,
                        ClassMetaData meta)

Constructor.

Parameters:

meta - the metadata to verify

Method Detail

main

public static void main(String[] args)
                 throws ClassNotFoundException,
                        IOException

Usage: java com.solarmetric.kodo.impl.jdbc.MetaDataVerifier [class name | .class file | .jdo file]+

Each argument can be either the full class name of a persistence capable type, the path to the .class file for the type, or the path to a .jdo file listing one or more types. If a given type has JDO metadata, it will be verified against the current capabilities of the O/R mapping layer. If not, it will be ignored.

main

public static void main(String[] args,
                        PrintStream out)
                 throws ClassNotFoundException,
                        IOException

verifyAll

public void verifyAll()

Verifies the given metadata against he current capabilities of the O/R layer.

clearMessages

public void clearMessages()

Clears the messages that have been accumulated from the verification thus far.

getMessages

public MetaDataVerifier.Msg[] getMessages()

Returns the accumulated messages from the verification that has been performed thus far.

verifySuperclass

public void verifySuperclass()

Warns if the described type has a persistence-capable superclass but does not appear to specify it in the metadata.

verifyPrimaryKeys

public void verifyPrimaryKeys()

Warns if the user has specified primary key fields that are not persistable as simple value mappings.

verifyFields

public void verifyFields()

Checks that field types are persistable.

verifyImplicitPersistence

public void verifyImplicitPersistence()

Checks that the field meta datas are not being implicitly set to persistent, possibly causing unexpected serialization behavior.