blob: 505e4d7ff517185904f394fb46135c36c78a02bb (
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
|
/*******************************************************************************
* Copyright (c) 2008, 2010 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.jpa.core.context.orm;
import java.util.ListIterator;
import org.eclipse.jpt.jpa.core.context.Entity;
import org.eclipse.jpt.jpa.core.context.ReadOnlyPrimaryKeyJoinColumn;
import org.eclipse.jpt.jpa.core.context.ReadOnlySecondaryTable;
import org.eclipse.jpt.jpa.core.context.java.JavaEntity;
import org.eclipse.jpt.jpa.core.resource.orm.XmlEntity;
/**
* <code>orm.xml</code> entity
* <p>
* 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.
*
* @version 2.3
* @since 2.0
*/
public interface OrmEntity
extends Entity, OrmTypeMapping
{
XmlEntity getXmlTypeMapping();
JavaEntity getJavaTypeMapping();
JavaEntity getJavaTypeMappingForDefaults();
OrmTable getTable();
OrmIdClassReference getIdClassReference();
OrmDiscriminatorColumn getDiscriminatorColumn();
// ********** secondary tables **********
ListIterator<ReadOnlySecondaryTable> secondaryTables();
ListIterator<OrmSecondaryTable> specifiedSecondaryTables();
OrmSecondaryTable addSpecifiedSecondaryTable();
OrmSecondaryTable addSpecifiedSecondaryTable(int index);
/**
* Return the virtual (not specified) secondary tables.
*/
ListIterator<OrmVirtualSecondaryTable> virtualSecondaryTables();
String VIRTUAL_SECONDARY_TABLES_LIST = "virtualSecondaryTables"; //$NON-NLS-1$
/**
* Return the number of virtual secondary tables.
*/
int virtualSecondaryTablesSize();
/**
* 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 secondaryTablesAreDefinedInXml();
/**
* 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 setSecondaryTablesAreDefinedInXml(boolean defineInXml);
// ********** primary key join columns **********
ListIterator<ReadOnlyPrimaryKeyJoinColumn> primaryKeyJoinColumns();
ListIterator<OrmPrimaryKeyJoinColumn> specifiedPrimaryKeyJoinColumns();
OrmPrimaryKeyJoinColumn addSpecifiedPrimaryKeyJoinColumn();
OrmPrimaryKeyJoinColumn addSpecifiedPrimaryKeyJoinColumn(int index);
ListIterator<ReadOnlyPrimaryKeyJoinColumn> defaultPrimaryKeyJoinColumns();
String DEFAULT_PRIMARY_KEY_JOIN_COLUMNS_LIST = "defaultPrimaryKeyJoinColumns"; //$NON-NLS-1$
// ********** containers **********
OrmAttributeOverrideContainer getAttributeOverrideContainer();
OrmAssociationOverrideContainer getAssociationOverrideContainer();
OrmQueryContainer getQueryContainer();
OrmGeneratorContainer getGeneratorContainer();
}
|
