001: /*
002: * JBoss, Home of Professional Open Source.
003: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
004: * as indicated by the @author tags. See the copyright.txt file in the
005: * distribution for a full listing of individual contributors.
006: *
007: * This is free software; you can redistribute it and/or modify it
008: * under the terms of the GNU Lesser General Public License as
009: * published by the Free Software Foundation; either version 2.1 of
010: * the License, or (at your option) any later version.
011: *
012: * This software is distributed in the hope that it will be useful,
013: * but WITHOUT ANY WARRANTY; without even the implied warranty of
014: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015: * Lesser General Public License for more details.
016: *
017: * You should have received a copy of the GNU Lesser General Public
018: * License along with this software; if not, write to the Free
019: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
020: * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
021: */
022: package org.jboss.metadata;
023:
024: import org.w3c.dom.Element;
025: import org.jboss.deployment.DeploymentException;
026:
027: /**
028: * Represents one ejb-relationship-role element found in the ejb-jar.xml
029: * file's ejb-relation elements.
030: *
031: * @author <a href="mailto:dain@daingroup.com">Dain Sundstrom</a>
032: * @version $Revision: 57209 $
033: */
034: public class RelationshipRoleMetaData extends MetaData {
035: // one is one
036: private static int ONE = 1;
037: // and two is many :)
038: private static int MANY = 2;
039:
040: /**
041: * Role name
042: */
043: private String relationshipRoleName;
044:
045: /**
046: * The relation to which the role belongs.
047: */
048: private RelationMetaData relationMetaData;
049:
050: /**
051: * Multiplicity of role, ONE or MANY.
052: */
053: private int multiplicity;
054:
055: /**
056: * Should this entity be deleted when related entity is deleted.
057: */
058: private boolean cascadeDelete;
059:
060: /**
061: * Name of the entity that has this role.
062: */
063: private String entityName;
064:
065: /**
066: * Name of the entity's cmr field for this role.
067: */
068: private String cmrFieldName;
069:
070: /**
071: * Type of the cmr field (i.e., collection or set)
072: */
073: private String cmrFieldType;
074:
075: public RelationshipRoleMetaData(RelationMetaData relationMetaData) {
076: this .relationMetaData = relationMetaData;
077: }
078:
079: /**
080: * Gets the relationship role name
081: */
082: public String getRelationshipRoleName() {
083: return relationshipRoleName;
084: }
085:
086: /**
087: * Gets the relation meta data to which the role belongs.
088: * @returns the relation to which the relationship role belongs
089: */
090: public RelationMetaData getRelationMetaData() {
091: return relationMetaData;
092: }
093:
094: /**
095: * Gets the related role's metadata
096: */
097: public RelationshipRoleMetaData getRelatedRoleMetaData() {
098: return relationMetaData.getOtherRelationshipRole(this );
099: }
100:
101: /**
102: * Checks if the multiplicity is one.
103: */
104: public boolean isMultiplicityOne() {
105: return multiplicity == ONE;
106: }
107:
108: /**
109: * Checks if the multiplicity is many.
110: */
111: public boolean isMultiplicityMany() {
112: return multiplicity == MANY;
113: }
114:
115: /**
116: * Should this entity be deleted when related entity is deleted.
117: */
118: public boolean isCascadeDelete() {
119: return cascadeDelete;
120: }
121:
122: /**
123: * Gets the name of the entity that has this role.
124: */
125: public String getEntityName() {
126: return entityName;
127: }
128:
129: /**
130: * Gets the name of the entity's cmr field for this role.
131: */
132: public String getCMRFieldName() {
133: return cmrFieldName;
134: }
135:
136: /**
137: * Gets the type of the cmr field (i.e., collection or set)
138: */
139: public String getCMRFieldType() {
140: return cmrFieldType;
141: }
142:
143: public void importEjbJarXml(Element element)
144: throws DeploymentException {
145: // ejb-relationship-role-name?
146: relationshipRoleName = getOptionalChildContent(element,
147: "ejb-relationship-role-name");
148:
149: // multiplicity
150: String multiplicityString = getUniqueChildContent(element,
151: "multiplicity");
152: if ("One".equals(multiplicityString)) {
153: multiplicity = ONE;
154: } else if ("Many".equals(multiplicityString)) {
155: multiplicity = MANY;
156: } else {
157: throw new DeploymentException(
158: "multiplicity must be exactaly 'One' "
159: + "or 'Many' but is " + multiplicityString
160: + "; this is case " + "sensitive");
161: }
162:
163: // cascade-delete?
164: if (getOptionalChild(element, "cascade-delete") != null) {
165: cascadeDelete = true;
166: }
167:
168: // relationship-role-source
169: Element relationshipRoleSourceElement = getUniqueChild(element,
170: "relationship-role-source");
171: entityName = getUniqueChildContent(
172: relationshipRoleSourceElement, "ejb-name");
173:
174: // cmr-field?
175: Element cmrFieldElement = getOptionalChild(element, "cmr-field");
176: if (cmrFieldElement != null) {
177: // cmr-field-name
178: cmrFieldName = getUniqueChildContent(cmrFieldElement,
179: "cmr-field-name");
180:
181: // cmr-field-type?
182: cmrFieldType = getOptionalChildContent(cmrFieldElement,
183: "cmr-field-type");
184: if (cmrFieldType != null
185: && !cmrFieldType.equals("java.util.Collection")
186: && !cmrFieldType.equals("java.util.Set")) {
187:
188: throw new DeploymentException(
189: "cmr-field-type should be "
190: + "java.util.Collection or java.util.Set but is "
191: + cmrFieldType);
192: }
193: }
194:
195: // JBossCMP needs ejb-relationship-role-name if jbosscmp-jdbc.xml is used to map relationships
196: if (relationshipRoleName == null) {
197: relationshipRoleName = entityName
198: + (cmrFieldName == null ? "" : "_" + cmrFieldName);
199: }
200: }
201: }
|