EclipseLink/Development/Dynamic/Design PublicAPI

From Eclipsepedia

< EclipseLink‎ | Development‎ | Dynamic
Revision as of 11:41, 24 September 2009 by Michael.norman.oracle.com (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

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.

Dynpersist.png

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 1.2/2.0
Method Summary
<T> T

get(String propertyPath)
Return the persistence value for the given property as the specified type.
boolean isSet(String propertyPath)
Discover if a property has a persistent value
DynamicEntity set(String propertyPath, Object value)
Set the persistence value for the given property to the specified value


public interface EntityType
  • Provides access to the type information (meta-model) as well as functioning as a factory for new instances

An EntityType provides a metadata facade into the EclipseLink object-relational metadata (descriptors & mappings)
with specific knowledge of the entity types being dynamic.

Since:
EclipseLink 1.2/2.0
Method Summary
boolean containsProperty(String propertyName)
String getClassName()
o.e.p.descriptors.ClassDescriptor getDescriptor()
Class<?> getJavaClass()
String getName()
Return the entity type's name.
int getNumberOfProperties()
The current number of properties.
EntityType getParentType()
java.util.List<String> getPropertiesNames()
The current names of properties.
int getPropertyIndex(String propertyName)
Class<?> getPropertyType(int propertyIndex)
Class<?> getPropertyType(String propertyName)
DynamicEntity newInstance()



public class EntityTypeBuilder
  • Factory for creating dynamic types and bootstrapping using XML

The EntityTypeBuilder is a factory class for creating and extending dynamic entity types. After being constructed in either usage the application can then use the provided API to customize mapping information of the type.

Since:
EclipseLink 1.2
Constructor Summary
EntityTypeBuilder(Class<?> dynamicClass, o.e.p.dynamic.EntityType parentType, String...tableNames)
Create an EntityType for a new dynamic type.
EntityTypeBuilder(o.e.p.internal.dynamic.DynamicClassLoader dcl, o.e.p.descriptors.ClassDescriptor descriptor, o.e.p.dynamic.EntityType parentType)
Create an EntityTypeBuilder for an existing descriptor.
Method Summary
o.e.p.mappings.AggregateObjectMapping addAggregateObjectMapping(String name, o.e.p.dynamic.EntityType refType, boolean allowsNull)
TODO
o.e.p.mappings.DirectCollectionMapping addDirectCollectionMapping(String name, String targetTable, String valueColumn, Class<?> valueType, String...fkFieldNames)
TODO
o.e.p.mappings.DirectToFieldMapping addDirectMapping(String name, Class<?> javaType, String fieldName)
Allows DirectToFieldMapping (@Basic) mapping to be added to a dynamic type through API.
void addManyToManyMapping(String name, o.e.p.dynamic.EntityType refType, String relationshipTableName)
TODO
o.e.p.mappings.OneToManyMapping addOneToManyMapping(String name, o.e.p.dynamic.EntityType refType, String...fkFieldNames)
TODO
o.e.p.mappings.OneToOneMapping addOneToOneMapping(String name, o.e.p.dynamic.EntityType refType, String...fkFieldNames)
Allows OneToOneMapping (@OneToOne and @ManyToOne) mappings to be added to a dynamic type through API.
void addToSession(o.e.p.sessions.DatabaseSession session, boolean createMissingTables, boolean generateFKConstraints)
static void addToSession(o.e.p.sessions.DatabaseSession session, boolean createMissingTables, boolean generateFKConstraints, o.e.p.dynamic.EntityType...types)
Add one or more EntityType instances to a session and optionally generate needed tables with or without FK constraints.
void configureSequencing(o.e.p.sequencing.Sequence sequence, String numberName, String numberFieldName)
void configureSequencing(String numberName, String numberFieldName)
o.e.p.dynamic.EntityType getType()
static o.e.p.sessions.Project loadDynamicProject(java.io.InputStream resourceStream, o.e.p.sessions.DatabaseLogin login, o.e.p.internal.dynamic.DynamicClassLoader dynamicClassLoader)
Load a dynamic project from deployment XML creating dynamic types for all descriptors where the provided class name does not exist.
static o.e.p.sessions.Project loadDynamicProject(String resourcePath, o.e.p.sessions.DatabaseLogin login, o.e.p.internal.dynamic.DynamicClassLoader dynamicClassLoader)
Load a dynamic project from deployment XML creating dynamic types for all descriptors where the provided class name does not exist.
void setPrimaryKeyFields(String... pkFieldNames)
Set the PK field names on the underlying descriptor ensuring no duplicate names are added.

Internal Design

New package org.eclipse.persistence.internal.dynamic