org.objectweb.speedo.metadata
Class SpeedoPackage

java.lang.Object
  extended by org.objectweb.speedo.metadata.SpeedoElement
      extended by org.objectweb.speedo.metadata.SpeedoPackage
All Implemented Interfaces:
java.io.Serializable

public class SpeedoPackage
extends SpeedoElement

Describes a package which contains persistence capable classes.

Author:
S.Chassande-Barrioz
See Also:
Serialized Form

Field Summary
 java.util.Map classes
          Persistence capable classes descriptors of the package.
 java.lang.String name
          Package name.
 java.util.Map sequences
          Sequences descriptors of the package.
 SpeedoXMLDescriptor xmlDescriptor
          Descriptor to which this package is associated.
 
Fields inherited from class org.objectweb.speedo.metadata.SpeedoElement
jdoExtension, personality
 
Constructor Summary
SpeedoPackage()
           
 
Method Summary
 void addClass(java.lang.Object clazz, boolean failsOnError, org.objectweb.util.monolog.api.Logger logger)
          Adds a class descriptor to the package descriptor.
 void addSequence(java.lang.Object sequence)
          Adds a sequence descriptor to the package descriptor.
 java.lang.String toString()
          Transforms a SpeedoPackage into a String.
 
Methods inherited from class org.objectweb.speedo.metadata.SpeedoElement
addExtension, addInArray, getExtension, getExtensionByKey, getExtensionValueByKey, indexOfInArray, removeInArray, setValueInArray
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

name

public java.lang.String name
Package name.


classes

public java.util.Map classes
Persistence capable classes descriptors of the package. The HashMap key is the class name.


sequences

public java.util.Map sequences
Sequences descriptors of the package. The HashMap key is the sequence name.


xmlDescriptor

public SpeedoXMLDescriptor xmlDescriptor
Descriptor to which this package is associated.

Constructor Detail

SpeedoPackage

public SpeedoPackage()
Method Detail

toString

public java.lang.String toString()
Transforms a SpeedoPackage into a String.

Overrides:
toString in class java.lang.Object
Returns:
the corresponding String.

addClass

public void addClass(java.lang.Object clazz,
                     boolean failsOnError,
                     org.objectweb.util.monolog.api.Logger logger)
              throws SpeedoException
Adds a class descriptor to the package descriptor.

Parameters:
clazz - class to add.
failsOnError - if an error provoques an exception or a warning message.
logger - logger where to put warning message.
Throws:
SpeedoException - If a field of the class descriptor is already defined into the package descriptor.

addSequence

public void addSequence(java.lang.Object sequence)
Adds a sequence descriptor to the package descriptor. If a sequence with the same name is already registered, nothing is done.

Parameters:
sequence - the sequence to add.