org.datanucleus.metadata
Class PackageMetaData

java.lang.Object
  extended by org.datanucleus.metadata.MetaData
      extended by org.datanucleus.metadata.PackageMetaData
All Implemented Interfaces:
java.io.Serializable

public class PackageMetaData
extends MetaData

Representation of the Meta-Data for a package.

See Also:
Serialized Form

Field Summary
protected  java.lang.String catalog
          Catalog name for all classes in this package
protected  java.util.List<ClassMetaData> classes
          List of classes (uses List to retain positioning).
protected  java.util.List<InterfaceMetaData> interfaces
          List of interfaces (uses List to retain positioning).
protected  java.lang.String name
          Package name
protected  java.lang.String schema
          Schema name for all classes in this package
protected  java.util.Collection<SequenceMetaData> sequences
          Sequence generators.
protected  java.util.Collection<TableGeneratorMetaData> tableGenerators
          Table generators.
 
Fields inherited from class org.datanucleus.metadata.MetaData
extensions, LOCALISER, METADATA_CREATED_STATE, METADATA_INITIALISED_STATE, METADATA_POPULATED_STATE, METADATA_USED_STATE, metaDataState, parent, VENDOR_NAME, VENDOR_NAME_OLD
 
Method Summary
 ClassMetaData addClass(ClassMetaData cmd)
          Method to add a class Meta-Data to the package.
 InterfaceMetaData addInterface(InterfaceMetaData imd)
          Method to add a interface Meta-Data to the package.
 void addSequence(SequenceMetaData seqmd)
          Method to add a sequence Meta-Data to the package.
 java.lang.String getCatalog()
          Accessor for the catalog name for all classes in this package
 ClassMetaData getClass(int i)
          Accessor for the Meta-Data of a class in this package.
 ClassMetaData getClass(java.lang.String name)
          Accessor for the Meta-Data of a class with the specified name.
 FileMetaData getFileMetaData()
          Accessor for the parent FileMetaData.
 InterfaceMetaData getInterface(int i)
          Accessor for the Meta-Data of a interface in this package.
 InterfaceMetaData getInterface(java.lang.String name)
          Accessor for the Meta-Data of an interface with the specified name.
 java.lang.String getName()
          Accessor for the name of the package
 int getNoOfClasses()
          Accessor for the number of classes.
 int getNoOfInterfaces()
          Accessor for the number of interfaces.
 int getNoOfSequences()
          Accessor for the number of sequences.
 int getNoOfTableGenerators()
          Accessor for the number of table generators.
 java.lang.String getSchema()
          Accessor for the schema name for all classes in this package
 SequenceMetaData getSequence(java.lang.String name)
          Accessor for the Meta-Data of an sequence with the specified name.
 SequenceMetaData[] getSequences()
          Accessor for the Meta-Data for the sequences in this package.
 TableGeneratorMetaData getTableGenerator(java.lang.String name)
          Accessor for the Meta-Data of a table generator with the specified name.
 TableGeneratorMetaData[] getTableGenerators()
          Accessor for the Meta-Data for the table generators in this package.
 void initialise(ClassLoaderResolver clr, MetaDataManager mmgr)
           
 ClassMetaData newClassMetadata(java.lang.String className)
          Method to create a new class metadata, add it, and return it.
 InterfaceMetaData newInterfaceMetadata(java.lang.String intfName)
          Method to create a new interface metadata, add it, and return it.
 SequenceMetaData newSequenceMetadata(java.lang.String seqName, java.lang.String seqStrategy)
          Method to create a new Sequence metadata, add it, and return it.
 TableGeneratorMetaData newTableGeneratorMetadata(java.lang.String name)
          Method to create a new TableGenerator metadata, add it and return it.
 PackageMetaData setCatalog(java.lang.String catalog)
           
 PackageMetaData setSchema(java.lang.String schema)
           
 java.lang.String toString(java.lang.String prefix, java.lang.String indent)
          Returns a string representation of the object.
 
Methods inherited from class org.datanucleus.metadata.MetaData
addExtension, addExtension, assertIfInitialised, getExtensions, getNoOfExtensions, getParent, getValueForExtension, getValuesForExtension, hasExtension, isInitialised, isPopulated, isUsed, newExtensionMetaData, removeExtension, setParent, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

interfaces

protected java.util.List<InterfaceMetaData> interfaces
List of interfaces (uses List to retain positioning).


classes

protected java.util.List<ClassMetaData> classes
List of classes (uses List to retain positioning).


sequences

protected java.util.Collection<SequenceMetaData> sequences
Sequence generators.


tableGenerators

protected java.util.Collection<TableGeneratorMetaData> tableGenerators
Table generators.


name

protected final java.lang.String name
Package name


catalog

protected java.lang.String catalog
Catalog name for all classes in this package


schema

protected java.lang.String schema
Schema name for all classes in this package

Method Detail

initialise

public void initialise(ClassLoaderResolver clr,
                       MetaDataManager mmgr)
Overrides:
initialise in class MetaData

getFileMetaData

public FileMetaData getFileMetaData()
Accessor for the parent FileMetaData.

Returns:
File MetaData.

getName

public java.lang.String getName()
Accessor for the name of the package

Returns:
package name

getCatalog

public java.lang.String getCatalog()
Accessor for the catalog name for all classes in this package

Returns:
Catalog name to use.

getSchema

public java.lang.String getSchema()
Accessor for the schema name for all classes in this package

Returns:
Schema name to use.

getNoOfInterfaces

public int getNoOfInterfaces()
Accessor for the number of interfaces.

Returns:
Number of interfaces.

getInterface

public InterfaceMetaData getInterface(int i)
Accessor for the Meta-Data of a interface in this package.

Parameters:
i - interface index
Returns:
Meta-Data for the interface

getInterface

public InterfaceMetaData getInterface(java.lang.String name)
Accessor for the Meta-Data of an interface with the specified name.

Parameters:
name - the name of the interface
Returns:
Meta-Data for the interface

getNoOfClasses

public int getNoOfClasses()
Accessor for the number of classes.

Returns:
Number of classes.

getClass

public ClassMetaData getClass(int i)
Accessor for the Meta-Data of a class in this package.

Parameters:
i - class index
Returns:
Meta-Data for the class

getClass

public ClassMetaData getClass(java.lang.String name)
Accessor for the Meta-Data of a class with the specified name.

Parameters:
name - the name of the class
Returns:
Meta-Data for the class.

getNoOfSequences

public int getNoOfSequences()
Accessor for the number of sequences.

Returns:
Number of sequences.

getSequences

public SequenceMetaData[] getSequences()
Accessor for the Meta-Data for the sequences in this package.

Returns:
Meta-Data for the sequences

getSequence

public SequenceMetaData getSequence(java.lang.String name)
Accessor for the Meta-Data of an sequence with the specified name.

Parameters:
name - the name of the sequence
Returns:
Meta-Data for the sequence

getNoOfTableGenerators

public int getNoOfTableGenerators()
Accessor for the number of table generators.

Returns:
Number of table generators.

getTableGenerators

public TableGeneratorMetaData[] getTableGenerators()
Accessor for the Meta-Data for the table generators in this package.

Returns:
Meta-Data for the table generators

getTableGenerator

public TableGeneratorMetaData getTableGenerator(java.lang.String name)
Accessor for the Meta-Data of a table generator with the specified name.

Parameters:
name - the name of the table generator
Returns:
Meta-Data for the table generator

addClass

public ClassMetaData addClass(ClassMetaData cmd)
Method to add a class Meta-Data to the package.

Parameters:
cmd - Meta-Data for the class
Returns:
The class metadata that was added (or already existing)

newClassMetadata

public ClassMetaData newClassMetadata(java.lang.String className)
Method to create a new class metadata, add it, and return it.

Parameters:
className - Name of the class (in this package)
Returns:
The class metadata

addInterface

public InterfaceMetaData addInterface(InterfaceMetaData imd)
Method to add a interface Meta-Data to the package.

Parameters:
imd - Meta-Data for the interface
Returns:
The interface metadata that was added (or already existing)

newInterfaceMetadata

public InterfaceMetaData newInterfaceMetadata(java.lang.String intfName)
Method to create a new interface metadata, add it, and return it.

Parameters:
intfName - Name of the interface (in this package)
Returns:
The interface metadata

addSequence

public void addSequence(SequenceMetaData seqmd)
Method to add a sequence Meta-Data to the package.

Parameters:
seqmd - Meta-Data for the sequence

newSequenceMetadata

public SequenceMetaData newSequenceMetadata(java.lang.String seqName,
                                            java.lang.String seqStrategy)
Method to create a new Sequence metadata, add it, and return it.

Parameters:
seqName - Name of the sequence
seqStrategy - Strategy for the sequence
Returns:
The sequence metadata

newTableGeneratorMetadata

public TableGeneratorMetaData newTableGeneratorMetadata(java.lang.String name)
Method to create a new TableGenerator metadata, add it and return it.

Parameters:
name - Name of the table generator
Returns:
The metadata

setCatalog

public PackageMetaData setCatalog(java.lang.String catalog)

setSchema

public PackageMetaData setSchema(java.lang.String schema)

toString

public java.lang.String toString(java.lang.String prefix,
                                 java.lang.String indent)
Returns a string representation of the object.

Overrides:
toString in class MetaData
Parameters:
prefix - prefix string
indent - indent string
Returns:
a string representation of the object.


Copyright © 2010. All Rights Reserved.