001: /*
002: * The Apache Software License, Version 1.1
003: *
004: *
005: * Copyright (c) 2001 The Apache Software Foundation.
006: * All rights reserved.
007: *
008: * Redistribution and use in source and binary forms, with or without
009: * modification, are permitted provided that the following conditions
010: * are met:
011: *
012: * 1. Redistributions of source code must retain the above copyright
013: * notice, this list of conditions and the following disclaimer.
014: *
015: * 2. Redistributions in binary form must reproduce the above copyright
016: * notice, this list of conditions and the following disclaimer in
017: * the documentation and/or other materials provided with the
018: * distribution.
019: *
020: * 3. The end-user documentation included with the redistribution,
021: * if any, must include the following acknowledgment:
022: * "This product includes software developed by the
023: * Apache Software Foundation (http://www.apache.org/)."
024: * Alternately, this acknowledgment may appear in the software itself,
025: * if and wherever such third-party acknowledgments normally appear.
026: *
027: * 4. The names "Xerces" and "Apache Software Foundation" must
028: * not be used to endorse or promote products derived from this
029: * software without prior written permission. For written
030: * permission, please contact apache@apache.org.
031: *
032: * 5. Products derived from this software may not be called "Apache",
033: * nor may "Apache" appear in their name, without prior written
034: * permission of the Apache Software Foundation.
035: *
036: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
037: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
038: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
039: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
040: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
041: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
042: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
043: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
044: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
045: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
046: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
047: * SUCH DAMAGE.
048: * ====================================================================
049: *
050: * This software consists of voluntary contributions made by many
051: * individuals on behalf of the Apache Software Foundation and was
052: * originally based on software copyright (c) 1999, International
053: * Business Machines, Inc., http://www.apache.org. For more
054: * information on the Apache Software Foundation, please see
055: * <http://www.apache.org/>.
056: */
057:
058: package org.apache.xerces.validators.schema.identity;
059:
060: import org.xml.sax.SAXException;
061:
062: /**
063: * Interface for storing values associated to an identity constraint.
064: * Each value stored corresponds to a field declared for the identity
065: * constraint. One instance of an object implementing this interface
066: * is created for each identity constraint per element declaration in
067: * the instance document to store the information for this identity
068: * constraint.
069: * <p>
070: * <strong>Note:</strong> The component performing identity constraint
071: * collection and validation is responsible for providing an
072: * implementation of this interface. The component is also responsible
073: * for performing the necessary checks required by each type of identity
074: * constraint.
075: *
076: * @author Andy Clark, IBM
077: *
078: * @version $Id: ValueStore.java,v 1.4 2001/05/15 17:21:25 neilg Exp $
079: */
080: public interface ValueStore {
081:
082: //
083: // ValueStore methods
084: //
085:
086: /**
087: * Adds the specified value to the value store.
088: *
089: * @param value The value to add.
090: * @param field The field associated to the value. This reference
091: * is used to ensure that each field only adds a value
092: * once within a selection scope.
093: */
094: public void addValue(Field field, IDValue value) throws Exception;
095:
096: /* report an error if a nillable element is being keyed on.
097: * the implementor must check that a <key> really is present, not a <unique> or <keyref>.
098: * @param: id: the IdentityConstraint that has matched.
099: */
100: public void reportNilError(IdentityConstraint id) throws Exception;
101:
102: } // interface ValueStore
|