001: /***************************************************************
002: * This file is part of the [fleXive](R) project.
003: *
004: * Copyright (c) 1999-2008
005: * UCS - unique computing solutions gmbh (http://www.ucs.at)
006: * All rights reserved
007: *
008: * The [fleXive](R) project is free software; you can redistribute
009: * it and/or modify it under the terms of the GNU General Public
010: * License as published by the Free Software Foundation;
011: * either version 2 of the License, or (at your option) any
012: * later version.
013: *
014: * The GNU General Public License can be found at
015: * http://www.gnu.org/copyleft/gpl.html.
016: * A copy is found in the textfile GPL.txt and important notices to the
017: * license from the author are found in LICENSE.txt distributed with
018: * these libraries.
019: *
020: * This library is distributed in the hope that it will be useful,
021: * but WITHOUT ANY WARRANTY; without even the implied warranty of
022: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
023: * GNU General Public License for more details.
024: *
025: * For further information about UCS - unique computing solutions gmbh,
026: * please see the company website: http://www.ucs.at
027: *
028: * For further information about [fleXive](R), please see the
029: * project website: http://www.flexive.org
030: *
031: *
032: * This copyright notice MUST APPEAR in all copies of the file!
033: ***************************************************************/package com.flexive.shared.structure;
034:
035: import com.flexive.shared.exceptions.FxNotFoundException;
036:
037: import java.io.Serializable;
038:
039: /**
040: * Extension of FxType to hold relation mappings
041: *
042: * @author Markus Plesser (markus.plesser@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at)
043: */
044: public class FxTypeRelation implements Serializable {
045: private static final long serialVersionUID = 5059296100111806264L;
046: private FxType source;
047: private FxType destination;
048: protected int maxSource;
049: protected int maxDestination;
050:
051: /**
052: * Constructor, only used internally.
053: * Update relation mappings using FxTypeEdit!
054: *
055: * @param source source type
056: * @param destination destination type
057: * @param maxSource maximum number of allowed source instances, unlimited if 0
058: * @param maxDestination maximum number of allowed destination instances, unlimited if 0
059: */
060: public FxTypeRelation(FxType source, FxType destination,
061: int maxSource, int maxDestination) {
062: if (source == null || destination == null)
063: throw new IllegalArgumentException(
064: "source and destination must not be null!");
065: this .source = source;
066: this .destination = destination;
067: this .maxSource = maxSource;
068: this .maxDestination = maxDestination;
069: }
070:
071: /**
072: * Get the source FxType
073: *
074: * @return Source FxType
075: */
076: public FxType getSource() {
077: return source;
078: }
079:
080: /**
081: * Get the destination FxType
082: *
083: * @return Destination FxType
084: */
085: public FxType getDestination() {
086: return destination;
087: }
088:
089: /**
090: * Get the maximum number of allowed source instances, unlimited if 0
091: *
092: * @return maximum number of allowed source instances, unlimited if 0
093: */
094: public int getMaxSource() {
095: return maxSource;
096: }
097:
098: /**
099: * Get the maximum number of allowed destination instances, unlimited if 0
100: *
101: * @return maximum number of allowed destination instances, unlimited if 0
102: */
103: public int getMaxDestination() {
104: return maxDestination;
105: }
106:
107: /**
108: * Is there a limit on source instances?
109: *
110: * @return limit on source instances?
111: */
112: public boolean isSourceLimited() {
113: return this .maxSource != 0;
114: }
115:
116: /**
117: * Is there a limit on destination instances?
118: *
119: * @return limit on destination instances?
120: */
121: public boolean isDestinationLimited() {
122: return this .maxDestination != 0;
123: }
124:
125: /**
126: * Resolve references after initial loading
127: *
128: * @param env env
129: * @throws FxNotFoundException on errors
130: */
131: public void resolveReferences(FxEnvironment env)
132: throws FxNotFoundException {
133: if (getSource().getMode() == TypeMode.Preload
134: && getDestination().getMode() == TypeMode.Preload) {
135: this .source = env.getType(getSource().getId());
136: this .destination = env.getType(getDestination().getId());
137: }
138: }
139:
140: /**
141: * Get this FxTypeRelation as editable
142: *
143: * @return FxTypeRelationEdit
144: */
145: public FxTypeRelationEdit asEditable() {
146: return new FxTypeRelationEdit(this );
147: }
148:
149: /**
150: * Overrides Objet's eqials method.
151: * Compares two relations for same source and destination,
152: * comparing multiplicites is intentionally neglected
153: *
154: * @return <code>this.getSource().getId() == other.getSource().getId() &&
155: * this.getDestination().getId() == other.getDestination().getId()</code>
156: */
157: @Override
158: public boolean equals(Object o) {
159: if (o == null || !(o instanceof FxTypeRelation))
160: return false;
161: if (o == this )
162: return true;
163: if (this .getSource().getId() == ((FxTypeRelation) o)
164: .getSource().getId()
165: && this .getDestination().getId() == ((FxTypeRelation) o)
166: .getDestination().getId())
167: return true;
168: return false;
169: }
170:
171: @Override
172: public int hashCode() {
173: int result;
174: result = source.hashCode();
175: result = 31 * result + destination.hashCode();
176: return result;
177: }
178:
179: /*
180: * Compares two relations for same source and destination,
181: * and same multiplicites.
182: *
183: * @return <code>this.equals(other) && this.getMaxSource() == other.getMaxSource()
184: * && this.getMaxDestination() == other.getMaxDestination()</code>
185: */
186:
187: public boolean equalsCompletely(Object o) {
188: if (this .equals(o)
189: && this .getMaxSource() == ((FxTypeRelation) o)
190: .getMaxSource()
191: && this .getMaxDestination() == ((FxTypeRelation) o)
192: .getMaxDestination())
193: return true;
194:
195: return false;
196: }
197: }
|