001: /*
002: * $Id: Constraint.java,v 1.16 2005/12/20 18:32:40 ahimanikya Exp $
003: * =======================================================================
004: * Copyright (c) 2002-2004 Axion Development Team. All rights reserved.
005: *
006: * Redistribution and use in source and binary forms, with or without
007: * modification, are permitted provided that the following conditions
008: * are met:
009: *
010: * 1. Redistributions of source code must retain the above
011: * copyright notice, this list of conditions and the following
012: * disclaimer.
013: *
014: * 2. Redistributions in binary form must reproduce the above copyright
015: * notice, this list of conditions and the following disclaimer in
016: * the documentation and/or other materials provided with the
017: * distribution.
018: *
019: * 3. The names "Tigris", "Axion", nor the names of its contributors may
020: * not be used to endorse or promote products derived from this
021: * software without specific prior written permission.
022: *
023: * 4. Products derived from this software may not be called "Axion", nor
024: * may "Tigris" or "Axion" appear in their names without specific prior
025: * written permission.
026: *
027: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
028: * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
029: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
030: * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
031: * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
032: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
033: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
034: * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
035: * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
036: * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
037: * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
038: * =======================================================================
039: */
040:
041: package org.axiondb;
042:
043: import java.io.Serializable;
044:
045: import org.axiondb.event.RowEvent;
046:
047: /**
048: * A database constraint, such as UNIQUE or NOT NULL.
049: *
050: * @version $Revision: 1.16 $ $Date: 2005/12/20 18:32:40 $
051: * @author Rodney Waldhoff
052: * @author James Strachan
053: */
054: public interface Constraint extends Serializable {
055:
056: /**
057: * Evaluate the given <i>event </i> under me. Returns <code>false</code> if the
058: * constraint I represent has been violated.
059: */
060: boolean evaluate(RowEvent event) throws AxionException;
061:
062: /**
063: * Evaluate the given <i>event </i> under me. Returns <code>false</code> if the
064: * constraint I represent has been violated.
065: */
066: boolean evaluate(RowEvent event, RowDecorator dec)
067: throws AxionException;
068:
069: boolean evaluate(RowIterator oldRows, RowIterator newRows,
070: Table table) throws AxionException;
071:
072: /**
073: * Get my name.
074: */
075: String getName();
076:
077: /**
078: * Get a human-readable descrption of the type of constraint I represent.
079: */
080: String getType();
081:
082: /**
083: * Return whether or not I am deferrable.
084: */
085: boolean isDeferrable();
086:
087: /**
088: * Return whether or not I am deferred. Deferred constraints are not evaluated until
089: * the transaction is committed.
090: */
091: boolean isDeferred();
092:
093: /**
094: * Resolve any unresolved {@link org.axiondb.Selectableidentifiers} I may have.
095: */
096: void resolve(Database db, TableIdentifier table)
097: throws AxionException;
098:
099: /**
100: * Set whether or not I am deferrable.
101: */
102: void setDeferrable(boolean deferrable);
103:
104: /**
105: * Set whether or not I am deferred. Deferred constraints are not evaluated until the
106: * transaction is committed. Throws an exception if I am not
107: * {@link #isDeferrable deferrable}and <i>deferred </i> is <code>true</code>.
108: */
109: void setDeferred(boolean deferred) throws AxionException;
110:
111: /**
112: * Set my name.
113: */
114: void setName(String name);
115: }
|