KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectstyle > cayenne > map > Relationship


1 /* ====================================================================
2  *
3  * The ObjectStyle Group Software License, version 1.1
4  * ObjectStyle Group - http://objectstyle.org/
5  *
6  * Copyright (c) 2002-2005, Andrei (Andrus) Adamchik and individual authors
7  * of the software. All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  * notice, this list of conditions and the following disclaimer.
15  *
16  * 2. Redistributions in binary form must reproduce the above copyright
17  * notice, this list of conditions and the following disclaimer in
18  * the documentation and/or other materials provided with the
19  * distribution.
20  *
21  * 3. The end-user documentation included with the redistribution, if any,
22  * must include the following acknowlegement:
23  * "This product includes software developed by independent contributors
24  * and hosted on ObjectStyle Group web site (http://objectstyle.org/)."
25  * Alternately, this acknowlegement may appear in the software itself,
26  * if and wherever such third-party acknowlegements normally appear.
27  *
28  * 4. The names "ObjectStyle Group" and "Cayenne" must not be used to endorse
29  * or promote products derived from this software without prior written
30  * permission. For written permission, email
31  * "andrus at objectstyle dot org".
32  *
33  * 5. Products derived from this software may not be called "ObjectStyle"
34  * or "Cayenne", nor may "ObjectStyle" or "Cayenne" appear in their
35  * names without prior written permission.
36  *
37  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40  * DISCLAIMED. IN NO EVENT SHALL THE OBJECTSTYLE GROUP OR
41  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
44  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
46  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
47  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
48  * SUCH DAMAGE.
49  * ====================================================================
50  *
51  * This software consists of voluntary contributions made by many
52  * individuals and hosted on ObjectStyle Group web site. For more
53  * information on the ObjectStyle Group, please see
54  * <http://objectstyle.org/>.
55  */
56 package org.objectstyle.cayenne.map;
57
58 import org.apache.commons.lang.builder.ToStringBuilder;
59 import org.objectstyle.cayenne.CayenneRuntimeException;
60
61 /** Superclass of metadata relationship classes. */
62 public abstract class Relationship extends MapObject {
63
64     protected String JavaDoc targetEntityName;
65     protected boolean toMany;
66
67     public Relationship() {
68         super();
69     }
70
71     public Relationship(String JavaDoc name) {
72         this();
73         this.setName(name);
74     }
75
76     /**
77      * Returns relationship source entity.
78      */
79     public Entity getSourceEntity() {
80         return (Entity) this.getParent();
81     }
82
83     /**
84      * Sets relationship source entity.
85      */
86     public void setSourceEntity(Entity sourceEntity) {
87         setParent(sourceEntity);
88     }
89
90     /** Returns relationship target entity. */
91     public abstract Entity getTargetEntity();
92
93     /**
94      * Sets relationship target entity. Internally calls <code>setTargetEntityName</code>.
95      */
96     public void setTargetEntity(Entity targetEntity) {
97         if (targetEntity != null) {
98             this.setTargetEntityName(targetEntity.getName());
99         }
100         else {
101             this.setTargetEntityName(null);
102         }
103     }
104
105     /**
106      * Returns the targetEntityName.
107      *
108      * @return String
109      */
110     public String JavaDoc getTargetEntityName() {
111         return targetEntityName;
112     }
113
114     /**
115      * Sets the targetEntityName.
116      *
117      * @param targetEntityName The targetEntityName to set
118      */
119     public void setTargetEntityName(String JavaDoc targetEntityName) {
120         this.targetEntityName = targetEntityName;
121     }
122
123     /**
124      * Tells whether relationship from source to target is to-one or to-many. If
125      * one-to-many, getxxx() method of the data object class would return a list,
126      * otherwise it returns a single DataObject There is explicitly no setToMany on
127      * Relationship.. only DbRelationship supports such a notion, and ObjRelationship
128      * derives it's value from the underlying DbRelationship(s)
129      */
130     public boolean isToMany() {
131         return toMany;
132     }
133
134     final MappingNamespace getNonNullNamespace() {
135         Entity entity = getSourceEntity();
136
137         if (entity == null) {
138             throw new CayenneRuntimeException("Relationship '"
139                     + getName()
140                     + "' has no parent Entity.");
141         }
142
143         return entity.getNonNullNamespace();
144     }
145
146     public String JavaDoc toString() {
147         return new ToStringBuilder(this).append("name", getName()).toString();
148     }
149 }
150
Popular Tags