com.sun.enterprise.deployment
Class PersistenceUnitsDescriptor

java.lang.Object
  extended by java.util.Observable
      extended by com.sun.enterprise.deployment.DynamicAttributesDescriptor
          extended by com.sun.enterprise.deployment.Descriptor
              extended by com.sun.enterprise.deployment.RootDeploymentDescriptor
                  extended by com.sun.enterprise.deployment.PersistenceUnitsDescriptor
All Implemented Interfaces:
java.io.Serializable

public class PersistenceUnitsDescriptor
extends RootDeploymentDescriptor

This descriptor represents contents for one persistence.xml file.

Author:
Sanjeeb.Sahoo@Sun.COM
See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.sun.enterprise.deployment.RootDeploymentDescriptor
classLoader, extensions, moduleDescriptor, moduleID
 
Fields inherited from class com.sun.enterprise.deployment.Descriptor
DESCRIPTION_CHANGED, DESCRIPTOR_CHANGED, docType, LARGE_ICON_CHANGED, NAME_CHANGED, SMALL_ICON_CHANGED
 
Constructor Summary
PersistenceUnitsDescriptor()
           
 
Method Summary
 void addPersistenceUnitDescriptor(PersistenceUnitDescriptor pud)
          This method does not do any validation like checking for unique names of PersistenceUnits.
 java.lang.String getAbsolutePuRoot()
          This is a utility method which calculates the absolute path of the root of a PU.
 java.lang.ClassLoader getClassLoader()
           
 java.lang.String getDefaultSpecVersion()
           
 java.lang.String getModuleID()
           
 XModuleType getModuleType()
           
 RootDeploymentDescriptor getParent()
           
 java.util.List<PersistenceUnitDescriptor> getPersistenceUnitDescriptors()
           
 java.lang.String getPuRoot()
           
 boolean isApplication()
           
 boolean isEmpty()
          Return true if this root deployment descriptor does not describe anything
 void setParent(RootDeploymentDescriptor parent)
           
 void setPuRoot(java.lang.String puRoot)
           
 
Methods inherited from class com.sun.enterprise.deployment.RootDeploymentDescriptor
addExtensionDescriptor, getDisplayName, getExtensionsDescriptors, getExtensionsDescriptors, getExtensionsDescriptors, getMainDescriptor, getModuleDescriptor, getName, getSchemaLocation, getSpecVersion, isDDWithNoAnnotationAllowed, isExtensionDescriptor, isFullAttribute, isFullFlag, print, setClassLoader, setDisplayName, setFullAttribute, setFullFlag, setModuleDescriptor, setModuleID, setName, setSchemaLocation, setSpecVersion
 
Methods inherited from class com.sun.enterprise.deployment.Descriptor
addDeploymentExtension, addPrefixMapping, createUniqueFilenameAmongst, createUniqueNameAmongst, createUniqueNameAmongstNamedDescriptors, fillDocType, getDeploymentExtensions, getDescription, getDocType, getLargeIconUri, getLocalizedDescription, getLocalizedDescriptions, getLocalizedDisplayName, getLocalizedDisplayNames, getLocalizedLargeIconUri, getLocalizedLargeIconUris, getLocalizedSmallIconUri, getLocalizedSmallIconUris, getPrefixMapping, getSmallIconUri, isBoundsChecking, setBoundsChecking, setDescription, setLargeIconUri, setLocalizedDescription, setLocalizedDisplayName, setLocalizedLargeIconUri, setLocalizedSmallIconUri, setSmallIconUri, visit
 
Methods inherited from class com.sun.enterprise.deployment.DynamicAttributesDescriptor
addExtraAttribute, getExtraAttribute, getExtraAttributes, removeExtraAttribute, toString
 
Methods inherited from class java.util.Observable
addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PersistenceUnitsDescriptor

public PersistenceUnitsDescriptor()
Method Detail

getParent

public RootDeploymentDescriptor getParent()

setParent

public void setParent(RootDeploymentDescriptor parent)

getPuRoot

public java.lang.String getPuRoot()

setPuRoot

public void setPuRoot(java.lang.String puRoot)

getDefaultSpecVersion

public java.lang.String getDefaultSpecVersion()
Specified by:
getDefaultSpecVersion in class RootDeploymentDescriptor
Returns:
the default version of the deployment descriptor loaded by this descriptor

getModuleID

public java.lang.String getModuleID()
Specified by:
getModuleID in class RootDeploymentDescriptor
Returns:
the module ID for this module descriptor

getModuleType

public XModuleType getModuleType()
Specified by:
getModuleType in class RootDeploymentDescriptor
Returns:
the module type for this bundle descriptor

getClassLoader

public java.lang.ClassLoader getClassLoader()
Specified by:
getClassLoader in class RootDeploymentDescriptor
Returns:
the class loader associated with this module

isApplication

public boolean isApplication()
Specified by:
isApplication in class RootDeploymentDescriptor
Returns:
true if this module is an application object

addPersistenceUnitDescriptor

public void addPersistenceUnitDescriptor(PersistenceUnitDescriptor pud)
This method does not do any validation like checking for unique names of PersistenceUnits.

Parameters:
pud - the PersistenceUnitDescriptor to be added.

getPersistenceUnitDescriptors

public java.util.List<PersistenceUnitDescriptor> getPersistenceUnitDescriptors()
Returns:
an unmodifiable list.

getAbsolutePuRoot

public java.lang.String getAbsolutePuRoot()
This is a utility method which calculates the absolute path of the root of a PU. Absolute path is not the path with regards to root of file system. It is the path from the root of the Java EE application this persistence unit belongs to. Like getPuRoot() returned path always uses '/' as path separator.

Returns:
the absolute path of the root of this persistence unit
See Also:
getPuRoot()

isEmpty

public boolean isEmpty()
Description copied from class: RootDeploymentDescriptor
Return true if this root deployment descriptor does not describe anything

Specified by:
isEmpty in class RootDeploymentDescriptor
Returns:
true if this root descriptor is empty


Copyright © 2012 GlassFish Community. All Rights Reserved.