01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: */
17:
18: package org.apache.xerces.impl.xs.identity;
19:
20: /**
21: * Interface for a field activator. The field activator is responsible
22: * for activating fields within a specific scope; the caller merely
23: * requests the fields to be activated.
24: *
25: * @xerces.internal
26: *
27: * @author Andy Clark, IBM
28: *
29: * @version $Id: FieldActivator.java 520039 2007-03-19 18:34:38Z mrglavas $
30: */
31: public interface FieldActivator {
32:
33: //
34: // FieldActivator methods
35: //
36:
37: /**
38: * Start the value scope for the specified identity constraint. This
39: * method is called when the selector matches in order to initialize
40: * the value store.
41: *
42: * @param identityConstraint The identity constraint.
43: * @param initialDepth the depth at which the selector began matching
44: */
45: public void startValueScopeFor(
46: IdentityConstraint identityConstraint, int initialDepth);
47:
48: /**
49: * Request to activate the specified field. This method returns the
50: * matcher for the field.
51: *
52: * @param field The field to activate.
53: * @param initialDepth the 0-indexed depth in the instance document at which the Selector began to match.
54: */
55: public XPathMatcher activateField(Field field, int initialDepth);
56:
57: /**
58: * Ends the value scope for the specified identity constraint.
59: *
60: * @param identityConstraint The identity constraint.
61: * @param initialDepth the 0-indexed depth where the Selector began to match.
62: */
63: public void endValueScopeFor(IdentityConstraint identityConstraint,
64: int initialDepth);
65:
66: } // interface FieldActivator
|