|
EclipseLink 2.4.2, build 'v20130514-5956486' API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.persistence.sdo.helper.SDOHelperContext
public class SDOHelperContext
Purpose:
Nested Class Summary | |
---|---|
static class |
SDOHelperContext.MyNotificationFilter
INTERNAL: This class will be handed in as a parameter when adding a JBoss notification listener. |
Field Summary | |
---|---|
protected CopyHelper |
copyHelper
|
protected DataFactory |
dataFactory
|
protected DataHelper |
dataHelper
|
protected EqualityHelper |
equalityHelper
|
protected TypeHelper |
typeHelper
|
protected XMLHelper |
xmlHelper
|
protected XSDHelper |
xsdHelper
|
Constructor Summary | |
---|---|
SDOHelperContext()
Create a local HelperContext. |
|
SDOHelperContext(java.lang.ClassLoader aClassLoader)
Create a local HelperContext. |
|
SDOHelperContext(java.lang.String identifier)
Create a local HelperContext with the given identifier. |
|
SDOHelperContext(java.lang.String identifier,
java.lang.ClassLoader aClassLoader)
Create a local HelperContext with the given identifier. |
Method Summary | |
---|---|
static void |
addAlias(java.lang.String identifier,
java.lang.String alias)
Add an alias to identifier pair to the alias Map for the current application. |
ExternalizableDelegator.Resolvable |
createResolvable()
Create and return a new ExternalizableDelegator.Resolvable instance based on this helper context. |
ExternalizableDelegator.Resolvable |
createResolvable(java.lang.Object target)
Create and return a new ExternalizableDelegator.Resolvable instance based on this helper context and a given target. |
CopyHelper |
getCopyHelper()
Return the CopyHelper instance for this helper context. |
DataFactory |
getDataFactory()
Return the DataFactory instance for this helper context. |
DataHelper |
getDataHelper()
Return the DataHelper instance for this helper context. |
EqualityHelper |
getEqualityHelper()
Return the EqualityHelper instance for this helper context. |
static HelperContext |
getHelperContext()
INTERNAL: Return the helper context for a given key. |
static HelperContext |
getHelperContext(java.lang.String identifier)
Return the local helper context associated with the given identifier, or create one if it does not already exist. |
static HelperContext |
getHelperContext(java.lang.String identifier,
java.lang.ClassLoader classLoader)
Return the local helper context with the given identifier, or create one if it does not already exist. |
java.lang.String |
getIdentifier()
Return the unique label for this HelperContext. |
java.lang.Object |
getProperty(java.lang.String name)
Return the value stored in the properties Map for a given name, or null if an entry for name does not exist. |
TypeHelper |
getTypeHelper()
Return the TypeHelper instance for this helper context. |
XMLHelper |
getXMLHelper()
Return the XMLHelper instance for this helper context. |
XSDHelper |
getXSDHelper()
Return the XSDHelper instance for this helper context. |
static boolean |
hasHelperContext(java.lang.String identifier)
Return true if a HelperContext corresponding to this identifier or alias already exists, else false. |
protected void |
initialize(java.lang.ClassLoader aClassLoader)
The underlying helpers for this instance will be instantiated in this method. |
static boolean |
isApplicationResolverSet()
Indicates if a call to setApplicationResolver has been made. |
void |
makeDefaultContext()
ADVANCED Promote this helper context to be the default or global one. |
static void |
putHelperContext(java.lang.ClassLoader key,
HelperContext value)
INTERNAL: Put a ClassLoader/HelperContext key/value pair in the Thread HelperContext map. |
static void |
putHelperContext(HelperContext ctx)
Replaces the provided helper context in the map of identifiers to helper contexts for this application. ctx.getIdentifier() will be used to obtain the identifier value. |
static void |
removeHelperContext(java.lang.ClassLoader key)
INTERNAL: Remove a ClassLoader/HelperContext key/value pair from the Thread HelperContext map. |
static void |
removeHelperContext(java.lang.String identifier,
java.lang.ClassLoader key)
INTERNAL |
void |
reset()
Reset the Type,XML and XSD helper instances. |
static void |
setApplicationResolver(ApplicationResolver aResolver)
ADVANCED: Used to set an ApplicationResolver instance that will be used to retrieve info pertaining to a given application, such as the application name, in the case where our logic fails. |
void |
setProperty(java.lang.String name,
java.lang.Object value)
Add a name/value pair to the properties Map. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected CopyHelper copyHelper
protected DataFactory dataFactory
protected DataHelper dataHelper
protected EqualityHelper equalityHelper
protected XMLHelper xmlHelper
protected TypeHelper typeHelper
protected XSDHelper xsdHelper
Constructor Detail |
---|
public SDOHelperContext()
public SDOHelperContext(java.lang.String identifier)
identifier
- The unique label for this HelperContext.public SDOHelperContext(java.lang.ClassLoader aClassLoader)
aClassLoader
- This class loader will be used to find static
instance classes.public SDOHelperContext(java.lang.String identifier, java.lang.ClassLoader aClassLoader)
identifier
- The unique label for this HelperContext.aClassLoader
- This class loader will be used to find static
instance classes.Method Detail |
---|
public static void setApplicationResolver(ApplicationResolver aResolver)
aResolver
- the ApplicationResolver instance that will be used to retrieve
info pertaining to a given application. Note that null is
considered a valid set operation.
SDOException
- if more than one call is made to this method
in an active server instance.public static boolean isApplicationResolverSet()
protected void initialize(java.lang.ClassLoader aClassLoader)
aClassLoader
- public void reset()
public CopyHelper getCopyHelper()
getCopyHelper
in interface HelperContext
public DataFactory getDataFactory()
getDataFactory
in interface HelperContext
public DataHelper getDataHelper()
getDataHelper
in interface HelperContext
public EqualityHelper getEqualityHelper()
getEqualityHelper
in interface HelperContext
public TypeHelper getTypeHelper()
getTypeHelper
in interface HelperContext
public XMLHelper getXMLHelper()
getXMLHelper
in interface HelperContext
public XSDHelper getXSDHelper()
getXSDHelper
in interface HelperContext
public ExternalizableDelegator.Resolvable createResolvable()
public ExternalizableDelegator.Resolvable createResolvable(java.lang.Object target)
target
-
public static void putHelperContext(java.lang.ClassLoader key, HelperContext value)
key
- class loadervalue
- helper contextpublic static void removeHelperContext(java.lang.ClassLoader key)
key
- class loaderpublic static void removeHelperContext(java.lang.String identifier, java.lang.ClassLoader key)
identifier
- the specific identifier of the HelperContext to be removed. "" for a Global helperkey
- the ClassLoader associated with the HelperContext to be removedpublic static HelperContext getHelperContext()
public static HelperContext getHelperContext(java.lang.String identifier)
identifier
- the identifier or alias to use for lookup/creation
public static HelperContext getHelperContext(java.lang.String identifier, java.lang.ClassLoader classLoader)
public static void putHelperContext(HelperContext ctx)
ctx
- the HelperContext to be added to the context Map for
the current applicationpublic void makeDefaultContext()
public java.lang.String getIdentifier()
public static boolean hasHelperContext(java.lang.String identifier)
identifier
- the alias or identifier used to lookup a helper context
public static void addAlias(java.lang.String identifier, java.lang.String alias)
identifier
- assumed to be a key in the helper context Mapalias
- the alias to be associated with identifierpublic void setProperty(java.lang.String name, java.lang.Object value)
name
- the name of the propertyvalue
- the value of the propertypublic java.lang.Object getProperty(java.lang.String name)
name
- the name of the property to be returned
|
EclipseLink 2.4.2, build 'v20130514-5956486' API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |