org.objectweb.speedo.metadata
Class SpeedoXMLDescriptor

java.lang.Object
  extended byorg.objectweb.speedo.metadata.SpeedoXMLDescriptor

public class SpeedoXMLDescriptor
extends java.lang.Object

This class describes all persistence capable classes.

Author:
S.Chassande-Barrioz

Field Summary
 java.util.Map jdoPackage
          List of packages descriptions which contains persistence capable classes.
 java.util.Set mos
          The list of meta objects to serialize
 boolean requireEnhancement
           
 SpeedoMetaInfo smi
           
 java.lang.String xmlFile
           
 
Constructor Summary
SpeedoXMLDescriptor(SpeedoMetaInfo smi)
           
 
Method Summary
 void add(java.lang.Object pac, boolean failsOnError, org.objectweb.util.monolog.api.Logger logger)
          Adds a package descriptor to the global descriptor.
 SpeedoClass getSpeedoClass(java.lang.String fqn, boolean other)
           
 java.util.List getSpeedoClasses()
           
 java.util.List getSpeedoSequences()
           
 java.lang.String toString()
          Transform this object into a String.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

jdoPackage

public java.util.Map jdoPackage
List of packages descriptions which contains persistence capable classes.


smi

public SpeedoMetaInfo smi

xmlFile

public java.lang.String xmlFile

requireEnhancement

public boolean requireEnhancement

mos

public java.util.Set mos
The list of meta objects to serialize

Constructor Detail

SpeedoXMLDescriptor

public SpeedoXMLDescriptor(SpeedoMetaInfo smi)
Method Detail

toString

public java.lang.String toString()
Transform this object into a String.

Returns:
the string corresponding to the object.

add

public void add(java.lang.Object pac,
                boolean failsOnError,
                org.objectweb.util.monolog.api.Logger logger)
         throws SpeedoException
Adds a package descriptor to the global descriptor. Throws an exception if there are persistent capable fields defined twice.

Parameters:
pac - package descriptor to add.
failsOnError - if an error provoques an exception or a warning message.
logger - logger where to put warning message.
Throws:
SpeedoException - If a persistent field of the package was already described in the global descriptor.

getSpeedoClasses

public java.util.List getSpeedoClasses()

getSpeedoSequences

public java.util.List getSpeedoSequences()

getSpeedoClass

public SpeedoClass getSpeedoClass(java.lang.String fqn,
                                  boolean other)