KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > org > apache > xerces > internal > impl > xs > identity > FieldActivator


1 /*
2  * The Apache Software License, Version 1.1
3  *
4  *
5  * Copyright (c) 2001, 2002 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 com.sun.org.apache.xerces.internal.impl.xs.identity;
59
60
61 /**
62  * Interface for a field activator. The field activator is responsible
63  * for activating fields within a specific scope; the caller merely
64  * requests the fields to be activated.
65  *
66  * @author Andy Clark, IBM
67  *
68  * @version $Id: FieldActivator.java,v 1.6 2004/03/10 23:05:24 mrglavas Exp $
69  */
70 public interface FieldActivator {
71     
72     //
73 // FieldActivator methods
74 //
75
76     /**
77      * Start the value scope for the specified identity constraint. This
78      * method is called when the selector matches in order to initialize
79      * the value store.
80      *
81      * @param identityConstraint The identity constraint.
82      * @param initialDepth the depth at which the selector began matching
83      */
84     public void startValueScopeFor(IdentityConstraint identityConstraint,
85             int initialDepth);
86
87     /**
88      * Request to activate the specified field. This method returns the
89      * matcher for the field.
90      * It's also important for the implementor to ensure that it marks whether a Field
91      * is permitted to match a value--that is, to call the setMayMatch(Field, Boolean) method.
92      *
93      * @param field The field to activate.
94      * @param initialDepth the 0-indexed depth in the instance document at which the Selector began to match.
95      */
96     public XPathMatcher activateField(Field field, int initialDepth);
97     
98     /**
99      * Sets whether the given field is permitted to match a value.
100      * This should be used to catch instance documents that try
101      * and match a field several times in the same scope.
102      *
103      * @param field The field that may be permitted to be matched.
104      * @param state Boolean indiciating whether the field may be matched.
105      */
106     public void setMayMatch(Field field, Boolean JavaDoc state);
107     
108     /**
109      * Returns whether the given field is permitted to match a value.
110      *
111      * @param field The field that may be permitted to be matched.
112      * @return Boolean indicating whether the field may be matched.
113      */
114     public Boolean JavaDoc mayMatch(Field field);
115
116     /**
117      * Ends the value scope for the specified identity constraint.
118      *
119      * @param identityConstraint The identity constraint.
120      * @param initialDepth the 0-indexed depth where the Selector began to match.
121      */
122     public void endValueScopeFor(IdentityConstraint identityConstraint, int initialDepth);
123
124 } // interface FieldActivator
125
Popular Tags