001: /*
002: * ====================================================================
003: * JAFFA - Java Application Framework For All
004: *
005: * Copyright (C) 2002 JAFFA Development Group
006: *
007: * This library is free software; you can redistribute it and/or
008: * modify it under the terms of the GNU Lesser General Public
009: * License as published by the Free Software Foundation; either
010: * version 2.1 of the License, or (at your option) any later version.
011: *
012: * This library 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 library; if not, write to the Free Software
019: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
020: *
021: * Redistribution and use of this software and associated documentation ("Software"),
022: * with or without modification, are permitted provided that the following conditions are met:
023: * 1. Redistributions of source code must retain copyright statements and notices.
024: * Redistributions must also contain a copy of this document.
025: * 2. Redistributions in binary form must reproduce the above copyright notice,
026: * this list of conditions and the following disclaimer in the documentation
027: * and/or other materials provided with the distribution.
028: * 3. The name "JAFFA" must not be used to endorse or promote products derived from
029: * this Software without prior written permission. For written permission,
030: * please contact mail to: jaffagroup@yahoo.com.
031: * 4. Products derived from this Software may not be called "JAFFA" nor may "JAFFA"
032: * appear in their names without prior written permission.
033: * 5. Due credit should be given to the JAFFA Project (http://jaffa.sourceforge.net).
034: *
035: * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED
036: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
037: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
038: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
039: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
040: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
041: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
042: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
043: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
044: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
045: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
046: * SUCH DAMAGE.
047: * ====================================================================
048: */
049:
050: package org.jaffa.rules.fieldvalidators;
051:
052: import org.apache.log4j.Logger;
053: import org.jaffa.datatypes.ValidationException;
054: import org.jaffa.exceptions.FrameworkException;
055: import org.jaffa.persistence.UOW;
056: import org.jaffa.persistence.Criteria;
057: import java.util.Collection;
058: import org.jaffa.datatypes.exceptions.InvalidForeignKeyException;
059: import org.jaffa.persistence.util.PersistentHelper;
060: import org.jaffa.util.MessageHelper;
061:
062: /** This Field Validator ensures that the field value is a valid Foreign key in the specified domainClass.
063: */
064: public class ForeignKeyFieldValidator extends AbstractFieldValidator {
065:
066: private static final Logger log = Logger
067: .getLogger(ForeignKeyFieldValidator.class);
068: private String m_domainClass;
069: private String m_property;
070:
071: /** Getter for property domainClass.
072: * @return Value of property domainClass.
073: */
074: public String getDomainClass() {
075: return m_domainClass;
076: }
077:
078: /** Setter for property domainClass.
079: * @param domainClass New value of property domainClass.
080: */
081: public void setDomainClass(String domainClass) {
082: m_domainClass = domainClass;
083: }
084:
085: /** Getter for property.
086: * @return Value of property.
087: */
088: public String getProperty() {
089: return m_property;
090: }
091:
092: /** Setter for property.
093: * @param property New value of property.
094: */
095: public void setProperty(String property) {
096: m_property = property;
097: }
098:
099: /** The RulesEngine will invoke this method to perform the field validation.
100: * @throws ValidationException if any validation rule fails.
101: * @throws FrameworkException if any framework error occurs.
102: */
103: public void validate() throws ValidationException,
104: FrameworkException {
105: if (getValue() != null) {
106: UOW uow = getUow();
107: boolean localUow = (uow == null);
108: try {
109: if (localUow)
110: uow = new UOW();
111:
112: Criteria c = new Criteria();
113: c.setTable(getDomainClass());
114: c.addCriteria(getProperty(), getValue());
115: Collection col = uow.query(c);
116: if (col.size() == 0) {
117: String str = "ForeignKey validation failed for the value '"
118: + getValue()
119: + "' against the domainClass/field - "
120: + getDomainClass() + '/' + getProperty();
121: log.error(str);
122: throw new InvalidForeignKeyException(
123: getLabelToken(), new Object[] {
124: getLabelToken(getDomainClass()),
125: getLabelToken(getDomainClass(),
126: getProperty()) });
127: }
128: } finally {
129: if (localUow && uow != null)
130: uow.rollback();
131: }
132: }
133: }
134:
135: private static String getLabelToken(String domainClassName)
136: throws FrameworkException {
137: String labelToken = null;
138: try {
139: labelToken = PersistentHelper
140: .getLabelToken(domainClassName);
141: } catch (Exception e) {
142: // don't do anything.. just return the domainClassName + fieldName
143: }
144: if (labelToken == null)
145: labelToken = MessageHelper.tokenize(domainClassName);
146: return labelToken;
147: }
148:
149: private static String getLabelToken(String domainClassName,
150: String fieldName) throws FrameworkException {
151: String labelToken = null;
152: try {
153: labelToken = PersistentHelper.getLabelToken(
154: domainClassName, fieldName);
155: } catch (Exception e) {
156: // don't do anything.. just return the domainClassName + fieldName
157: }
158: if (labelToken == null)
159: labelToken = MessageHelper.tokenize(fieldName);
160: return labelToken;
161: }
162:
163: }
|