Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "EclipseLink/Development/Dynamic/Design PublicAPI"
Line 8: | Line 8: | ||
* Primary interface of a dynamic persistent entity. This is the API an application uses to interact with an entity. | * Primary interface of a dynamic persistent entity. This is the API an application uses to interact with an entity. | ||
<code>DynamicEntity</code> is the public interface for dealing with dynamic persistent objects. | <code>DynamicEntity</code> is the public interface for dealing with dynamic persistent objects. | ||
− | The purpose of dynamic persistent objects is to enable (simple) data access when only mapping information is available | + | The purpose of dynamic persistent objects is to enable (simple) data access when only mapping information is available and no concrete Java model is present (specifically, no <tt>.class</tt> files .) |
− | Applications using <code>DynamicEntity</code>'s can access the persistent state using property names which correspond | + | Applications using <code>DynamicEntity</code>'s can access the persistent state using property names which correspond to the mapped attributes in the underlying EclipseLink descriptors. For properties mapped to containers (<code>Collection</code>,<code>Map</code>, etc.), the property is retrieved then the resulting container can be manipulated. |
To discover meta-data about a DynamicEntity's properties, see the <code>DynamicHelper</code> class | To discover meta-data about a DynamicEntity's properties, see the <code>DynamicHelper</code> class | ||
; '''Since:''' | ; '''Since:''' | ||
: EclipseLink 2.0 | : EclipseLink 2.0 | ||
− | |||
− | |||
{| width="50%" border="1" cellpadding="3" | {| width="50%" border="1" cellpadding="3" | ||
|- class="TableHeadingColor" bgcolor="#CCCCFF" | |- class="TableHeadingColor" bgcolor="#CCCCFF" |
Revision as of 14:46, 17 September 2009
Public API
This page captures the design of the public API - introduced in the new package org.eclipse.persistence.dynamic
- that allows developers to define and use dynamic entities.
- public interface DynamicEntity
- Primary interface of a dynamic persistent entity. This is the API an application uses to interact with an entity.
DynamicEntity
is the public interface for dealing with dynamic persistent objects.
The purpose of dynamic persistent objects is to enable (simple) data access when only mapping information is available and no concrete Java model is present (specifically, no .class files .)
Applications using DynamicEntity
's can access the persistent state using property names which correspond to the mapped attributes in the underlying EclipseLink descriptors. For properties mapped to containers (Collection
,Map
, etc.), the property is retrieved then the resulting container can be manipulated.
To discover meta-data about a DynamicEntity's properties, see the DynamicHelper
class
- Since:
- EclipseLink 2.0
Method Summary | ||
---|---|---|
|
get(java.lang.String propertyPath) Return the persistence value for the given property as the specified type. | |
boolean
|
isSet(java.lang.String propertyPath) Discover if a property has a persistent value | |
DynamicEntity
|
set(java.lang.String propertyPath, java.lang.Object value) Set the persistence value for the given property to the specified value |
- EntityType.java
- Provides access to the type information (meta-model) as well as functioning as a factory for new instances
- DynamicHelper.java
- Helper to lookup types
- EntityTypeBuilder.java
- Factory for creating dynamic types and bootstrapping using XML
- DynamicException.java (org.eclipse.persistence.exceptions)
- Dynamic usage exception
- DynamicSchemaManager.java (org.eclipse.persistence.tools.schemaframework)
- Extended SchemaManager for allowing incremental schema generation for new dynamic types
Internal Design
New package org.eclipse.persistence.internal.dynamic