1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
|
/*
* Copyright (c) 1998, 2018 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0,
* or the Eclipse Distribution License v. 1.0 which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
*/
// Contributors:
// dclarke, mnorman - Dynamic Persistence
// http://wiki.eclipse.org/EclipseLink/Development/Dynamic
// (https://bugs.eclipse.org/bugs/show_bug.cgi?id=200045)
//
package org.eclipse.persistence.dynamic;
//EclipseLink imports
import org.eclipse.persistence.exceptions.DynamicException;
/**
* <code>DynamicEntity</code> is the public interface for dealing with dynamic persistent objects.
* <p>
* The purpose of dynamic persistent objects is to enable (simple) data access when only mapping
* information is available <br>
* and no concrete Java model is present (specifically, no <tt>.class</tt> files .)
* <p>
* Applications using <code>DynamicEntity</code>'s can access the persistent state using property names
* which correspond <br>
* to the mapped attributes in the underlying EclipseLink descriptors.
* For properties mapped to containers ({@link java.util.Collection Collection},<br>
* {@link java.util.Map Map}, etc.), the property is retrieved then the resulting container can
* be manipulated.
* <pre>
* ...
* DynamicEntity de = ...; // retrieve from database
* Collection<String> myListOfGroups = de.<Collection<String>>get("myListOfGroups");
* if (!myListOfGroups.isEmpty()) {
* myListOfGroups.add("FabFour");
* }
* </pre>
* To discover meta-data about a DynamicEntity's properties, see the {@link DynamicHelper} class
*
* @author dclarke, mnorman
* @since EclipseLink 1.2
*/
public interface DynamicEntity {
/**
* Return the persistence value for the given property as the specified type.
* In the case of relationships, this call will populate lazy-loaded relationships
*
* @param <T>
* generic type of the property (if not provided, assume Object).
* If the property cannot be cast to the specific type, a {@link DynamicException}will be thrown.
* @param
* propertyName the name of a mapped property
* If the property cannot be found, a {@link DynamicException} will be thrown.
* @throws
* DynamicException
* @return
* persistent value or relationship container of the specified type
*/
public <T> T get(String propertyName) throws DynamicException;
/**
* Set the persistence value for the given property to the specified value
*
* @param
* propertyName the name of a mapped property
* If the property cannot be found, a {@link DynamicException} will be thrown.
* @param
* value the specified object
* @throws
* DynamicException
* @return
* the same DynamicEntity instance
*/
public DynamicEntity set(String propertyName, Object value) throws DynamicException;
/**
* Discover if a property has a persistent value
*
* @param
* propertyName the name of a mapped property
* If the property cannot be found, a {@link DynamicException} will be thrown.
* @return
* true if the property has been set
* @throws
* DynamicException
*/
public boolean isSet(String propertyName) throws DynamicException;
}
|
