← Back to branch summary

~vcs-imports/xena/trunk

« back to all changes in this revision

Viewing changes to ext/src/xerces-2_9_1/src/org/apache/xerces/impl/xs/identity/FieldActivator.java

  • Committer: matthewoliver
  • Date: 2009-12-10 03:18:07 UTC
  • Revision ID: vcs-imports@canonical.com-20091210031807-l086qguzdlljtkl9
Merged Xena Testing into Xena Stable for the Xena 5 release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ext/src/xerces-2_9_1/src/org/apache/xerces/impl/xs/identity/FieldActivator.java
 
1
/*
 
2
 * Licensed to the Apache Software Foundation (ASF) under one or more
 
3
 * contributor license agreements.  See the NOTICE file distributed with
 
4
 * this work for additional information regarding copyright ownership.
 
5
 * The ASF licenses this file to You under the Apache License, Version 2.0
 
6
 * (the "License"); you may not use this file except in compliance with
 
7
 * the License.  You may obtain a copy of the License at
 
8
 * 
 
9
 *      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
/**
 
22
 * Interface for a field activator. The field activator is responsible
 
23
 * for activating fields within a specific scope; the caller merely
 
24
 * requests the fields to be activated.
 
25
 *
 
26
 * @xerces.internal 
 
27
 *
 
28
 * @author Andy Clark, IBM
 
29
 *
 
30
 * @version $Id: FieldActivator.java,v 1.2 2009/12/10 03:18:45 matthewoliver Exp $
 
31
 */
 
32
public interface FieldActivator {
 
33
    
 
34
    //
 
35
    // FieldActivator methods
 
36
    //
 
37
 
 
38
    /**
 
39
     * Start the value scope for the specified identity constraint. This 
 
40
     * method is called when the selector matches in order to initialize 
 
41
     * the value store.
 
42
     *
 
43
     * @param identityConstraint The identity constraint.
 
44
     * @param initialDepth  the depth at which the selector began matching
 
45
     */
 
46
    public void startValueScopeFor(IdentityConstraint identityConstraint,
 
47
            int initialDepth);
 
48
 
 
49
    /** 
 
50
     * Request to activate the specified field. This method returns the
 
51
     * matcher for the field.
 
52
     *
 
53
     * @param field The field to activate.
 
54
     * @param initialDepth the 0-indexed depth in the instance document at which the Selector began to match.
 
55
     */
 
56
    public XPathMatcher activateField(Field field, int initialDepth);
 
57
 
 
58
    /**
 
59
     * Ends the value scope for the specified identity constraint.
 
60
     *
 
61
     * @param identityConstraint The identity constraint.
 
62
     * @param initialDepth  the 0-indexed depth where the Selector began to match.
 
63
     */
 
64
    public void endValueScopeFor(IdentityConstraint identityConstraint, int initialDepth);
 
65
 
 
66
} // interface FieldActivator