KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > enhydra > apache > xerces > validators > schema > identity > ValueStore


1 /*
2  * The Apache Software License, Version 1.1
3  *
4  *
5  * Copyright (c) 2001 The Apache Software Foundation.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in
17  * the documentation and/or other materials provided with the
18  * distribution.
19  *
20  * 3. The end-user documentation included with the redistribution,
21  * if any, must include the following acknowledgment:
22  * "This product includes software developed by the
23  * Apache Software Foundation (http://www.apache.org/)."
24  * Alternately, this acknowledgment may appear in the software itself,
25  * if and wherever such third-party acknowledgments normally appear.
26  *
27  * 4. The names "Xerces" and "Apache Software Foundation" must
28  * not be used to endorse or promote products derived from this
29  * software without prior written permission. For written
30  * permission, please contact apache@apache.org.
31  *
32  * 5. Products derived from this software may not be called "Apache",
33  * nor may "Apache" appear in their name, without prior written
34  * permission of the Apache Software Foundation.
35  *
36  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47  * SUCH DAMAGE.
48  * ====================================================================
49  *
50  * This software consists of voluntary contributions made by many
51  * individuals on behalf of the Apache Software Foundation and was
52  * originally based on software copyright (c) 1999, International
53  * Business Machines, Inc., http://www.apache.org. For more
54  * information on the Apache Software Foundation, please see
55  * <http://www.apache.org/>.
56  */
57
58 package org.enhydra.apache.xerces.validators.schema.identity;
59
60
61 /**
62  * Interface for storing values associated to an identity constraint.
63  * Each value stored corresponds to a field declared for the identity
64  * constraint. One instance of an object implementing this interface
65  * is created for each identity constraint per element declaration in
66  * the instance document to store the information for this identity
67  * constraint.
68  * <p>
69  * <strong>Note:</strong> The component performing identity constraint
70  * collection and validation is responsible for providing an
71  * implementation of this interface. The component is also responsible
72  * for performing the necessary checks required by each type of identity
73  * constraint.
74  *
75  * @author Andy Clark, IBM
76  *
77  * @version $Id: ValueStore.java,v 1.2 2005/01/26 08:28:45 jkjome Exp $
78  */
79 public interface ValueStore {
80     
81     //
82 // ValueStore methods
83 //
84
85     /**
86      * Adds the specified value to the value store.
87      *
88      * @param value The value to add.
89      * @param field The field associated to the value. This reference
90      * is used to ensure that each field only adds a value
91      * once within a selection scope.
92      */
93     public void addValue(Field field, IDValue value) throws Exception JavaDoc;
94
95     /* report an error if a nillable element is being keyed on.
96      * the implementor must check that a <key> really is present, not a <unique> or <keyref>.
97      * @param: id: the IdentityConstraint that has matched.
98      */
99     public void reportNilError(IdentityConstraint id) throws Exception JavaDoc;
100
101 } // interface ValueStore
102
Popular Tags