Package org.apache.openjpa.meta

Class MetaDataTool

java.lang.Object

org.apache.openjpa.meta.MetaDataTool

All Implemented Interfaces:

MetaDataModes

public class MetaDataTool
extends java.lang.Object
implements MetaDataModes

Tool for generating default metadata.

Since:

0.3.0

Author:

Abe White

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MetaDataTool.Flags	Run flags.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ACTION_ADD
static java.lang.String	ACTION_DROP
static java.lang.String[]	ACTIONS

Fields inherited from interface org.apache.openjpa.meta.MetaDataModes

MODE_ALL, MODE_ANN_MAPPING, MODE_MAPPING, MODE_MAPPING_INIT, MODE_META, MODE_NONE, MODE_QUERY

Constructor Summary

Constructors

Constructor	Description
MetaDataTool(OpenJPAConfiguration conf, java.lang.String action)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	clear()	Reset state.
java.lang.String	getAction()	The action supplied on construction.
java.io.File	getFile()	The file to generate metadata to.
MetaDataRepository	getRepository()	The repository to use to hold metadata.
java.io.Writer	getWriter()	The writer to generate metadata to.
static void	main(java.lang.String[] args)	Usage: java org.apache.openjpa.meta.MetaDataTool [option]* [-action/-a <add | drop>] <class name | .java file | .class file>+ Where the following options are recognized.
protected MetaDataRepository	newRepository()	Create a new metadata repository.
void	record()	Record metadata changes.
void	run(java.lang.Class cls)	Generate new metadata for the given class.
static boolean	run(OpenJPAConfiguration conf, java.lang.String[] args, Options opts)	Run the tool.
static boolean	run(OpenJPAConfiguration conf, java.lang.String[] args, MetaDataTool.Flags flags, MetaDataRepository repos, java.lang.ClassLoader loader)	Run the tool.
void	setFile(java.io.File file)	The file to generate metadata to.
void	setRepository(MetaDataRepository repos)	The repository to use to hold metadata.
void	setWriter(java.io.Writer writer)	The writer to generate metadata to.

Methods inherited from class java.lang.Object

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

Field Detail

ACTION_ADD

public static final java.lang.String ACTION_ADD

See Also:

Constant Field Values

ACTION_DROP

public static final java.lang.String ACTION_DROP

See Also:

Constant Field Values

ACTIONS

public static final java.lang.String[] ACTIONS

Constructor Detail

MetaDataTool

public MetaDataTool(OpenJPAConfiguration conf,
                    java.lang.String action)

Constructor. Supply configuration and action.

Method Detail

getAction

public java.lang.String getAction()

The action supplied on construction.

getFile

public java.io.File getFile()

The file to generate metadata to.

setFile

public void setFile(java.io.File file)

The file to generate metadata to.

getWriter

public java.io.Writer getWriter()

The writer to generate metadata to.

setWriter

public void setWriter(java.io.Writer writer)

The writer to generate metadata to.

getRepository

public MetaDataRepository getRepository()

The repository to use to hold metadata.

newRepository

protected MetaDataRepository newRepository()

Create a new metadata repository.

setRepository

public void setRepository(MetaDataRepository repos)

The repository to use to hold metadata.

clear

public void clear()

Reset state. This is called automatically after every record().

run

public void run(java.lang.Class cls)

Generate new metadata for the given class.

record

public void record()

Record metadata changes.

main

public static void main(java.lang.String[] args)
                 throws java.io.IOException

Usage: java org.apache.openjpa.meta.MetaDataTool [option]* [-action/-a <add | drop>] <class name | .java file | .class file>+ Where the following options are recognized.

• -properties/-p <properties file or resource>: The path or resource name of a OpenJPA properties file containing information as outlined in OpenJPAConfiguration. Optional.
• -<property name> <property value>: All bean properties of the OpenJPA OpenJPAConfiguration can be set by using their names and supplying a value.
• -file/-f <stdout | output file or resource>: The path or resource name of a file the metadata should be generated to. If the given file already contains metadata, the generated metadata will be merged into the existing document.

The available actions are:

• add: Generate default metadata for the given classes. This is the default action.
• drop: Remove existing metadata for the given classes.

Throws:

java.io.IOException

run

public static boolean run(OpenJPAConfiguration conf,
                          java.lang.String[] args,
                          Options opts)
                   throws java.io.IOException

Run the tool. Returns false if any invalid options were given.

Throws:

java.io.IOException

run

public static boolean run(OpenJPAConfiguration conf,
                          java.lang.String[] args,
                          MetaDataTool.Flags flags,
                          MetaDataRepository repos,
                          java.lang.ClassLoader loader)
                   throws java.io.IOException

Run the tool. Return false if invalid options were given. The given repository may be null.

Throws:

java.io.IOException