org.objectweb.speedo.metadata
Class SpeedoPackage

java.lang.Object
  extended byorg.objectweb.speedo.metadata.SpeedoElement
      extended byorg.objectweb.speedo.metadata.SpeedoPackage

public class SpeedoPackage
extends SpeedoElement

Describes a package which contains persistence capable classes.

Author:
S.Chassande-Barrioz

Field Summary
 java.util.Map jdoClass
          Persistence capable classes descriptors of the package.
 java.util.Map jdoSequence
          Sequences descriptors of the package.
 SpeedoXMLDescriptor jdoXMLDescriptor
          Descriptor to which this package is associated.
 java.lang.String name
          Package name.
 
Fields inherited from class org.objectweb.speedo.metadata.SpeedoElement
jdoExtension
 
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, getExtension, getExtensionByKey, getExtensionValueByKey
 
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.


jdoClass

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


jdoSequence

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


jdoXMLDescriptor

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

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.