blob: 1d848475eac7fca7943401dfc9eb9a1a7e3681f6 (
plain) (
blame)
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
/*******************************************************************************
* Copyright (c) 2008 Oracle. All rights reserved.
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0, which accompanies this distribution
* and is available at http://www.eclipse.org/legal/epl-v10.html.
*
* Contributors:
* Oracle - initial API and implementation
******************************************************************************/
package org.eclipse.jpt.core.context.orm;
import java.util.Iterator;
import java.util.ListIterator;
import org.eclipse.jpt.core.context.Entity;
import org.eclipse.jpt.core.context.java.JavaEntity;
import org.eclipse.jpt.core.resource.orm.XmlEntity;
/**
*
*
* Provisional API: This interface is part of an interim API that is still
* under development and expected to change significantly before reaching
* stability. It is available at this early stage to solicit feedback from
* pioneering adopters on the understanding that any code that uses this API
* will almost certainly be broken (repeatedly) as the API evolves.
*/
public interface OrmEntity extends OrmTypeMapping, Entity, OrmGeneratorHolder
{
/**
* Return a list iterator of the virtual(not specified) secondary tables.
* This will not be null.
*/
ListIterator<OrmSecondaryTable> virtualSecondaryTables();
String VIRTUAL_SECONDARY_TABLES_LIST = "virtualSecondaryTablesList";
/**
* Return the number of virtual secondary tables.
*/
int virtualSecondaryTablesSize();
/**
* Return whether the entity contains the given secondary table in its list of
* virtual secondary tables
*/
boolean containsVirtualSecondaryTable(OrmSecondaryTable secondaryTable);
/**
* Return true if there are no virtual secondary tables on the orm entity.
* This is used to determine whether you can add specified secondary tables.
* You must first make sure all virtual secondary tables have been specified
* in xml before adding more. This is because adding one secondary table to xml
* will override all the secondary tables specified in the java entity
*/
boolean secondaryTablesDefinedInXml();
/**
* If true, then all virtual secondary tables are added in as specified secondary tables to the xml.
* If false, then all the specified secondary tables are remvoed from the xml.
*/
void setSecondaryTablesDefinedInXml(boolean defineInXml);
/**
* Return the Java Entity this ORM Entity corresponds to. Return null if there is no
* java entity.
*/
JavaEntity getJavaEntity();
void initialize(XmlEntity entity);
void update(XmlEntity entity);
//************ covariant overrides *************
OrmTable getTable();
OrmDiscriminatorColumn getDiscriminatorColumn();
@SuppressWarnings("unchecked")
ListIterator<OrmSecondaryTable> secondaryTables();
@SuppressWarnings("unchecked")
ListIterator<OrmSecondaryTable> specifiedSecondaryTables();
OrmSecondaryTable addSpecifiedSecondaryTable(int index);
@SuppressWarnings("unchecked")
ListIterator<OrmPrimaryKeyJoinColumn> primaryKeyJoinColumns();
OrmPrimaryKeyJoinColumn getDefaultPrimaryKeyJoinColumn();
ListIterator<OrmPrimaryKeyJoinColumn> defaultPrimaryKeyJoinColumns();
String DEFAULT_PRIMARY_KEY_JOIN_COLUMNS_LIST = "defaultPrimaryKeyJoinColumnsList";
@SuppressWarnings("unchecked")
ListIterator<OrmPrimaryKeyJoinColumn> specifiedPrimaryKeyJoinColumns();
OrmPrimaryKeyJoinColumn addSpecifiedPrimaryKeyJoinColumn(int index);
@SuppressWarnings("unchecked")
ListIterator<OrmAttributeOverride> attributeOverrides();
@SuppressWarnings("unchecked")
ListIterator<OrmAttributeOverride> specifiedAttributeOverrides();
@SuppressWarnings("unchecked")
ListIterator<OrmAttributeOverride> virtualAttributeOverrides();
OrmAttributeOverride getAttributeOverrideNamed(String name);
@SuppressWarnings("unchecked")
ListIterator<OrmAssociationOverride> associationOverrides();
@SuppressWarnings("unchecked")
ListIterator<OrmAssociationOverride> specifiedAssociationOverrides();
@SuppressWarnings("unchecked")
ListIterator<OrmAssociationOverride> virtualAssociationOverrides();
@SuppressWarnings("unchecked")
ListIterator<OrmNamedQuery> namedQueries();
OrmNamedQuery addNamedQuery(int index);
@SuppressWarnings("unchecked")
ListIterator<OrmNamedNativeQuery> namedNativeQueries();
OrmNamedNativeQuery addNamedNativeQuery(int index);
Iterator<OrmPersistentAttribute> overridableAttributes();
Iterator<OrmPersistentAttribute> overridableAssociations();
}
|
