FieldActivator.java revision 286
0N/A/*
0N/A * reserved comment block
1472N/A * DO NOT REMOVE OR ALTER!
0N/A */
0N/A/*
0N/A * Copyright 2001,2002,2004 The Apache Software Foundation.
0N/A *
0N/A * Licensed under the Apache License, Version 2.0 (the "License");
0N/A * you may not use this file except in compliance with the License.
0N/A * You may obtain a copy of the License at
0N/A *
0N/A * http://www.apache.org/licenses/LICENSE-2.0
0N/A *
0N/A * Unless required by applicable law or agreed to in writing, software
0N/A * distributed under the License is distributed on an "AS IS" BASIS,
0N/A * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
0N/A * See the License for the specific language governing permissions and
0N/A * limitations under the License.
0N/A */
1472N/A
1472N/Apackage com.sun.org.apache.xerces.internal.impl.xs.identity;
1472N/A
0N/A
0N/A/**
0N/A * Interface for a field activator. The field activator is responsible
0N/A * for activating fields within a specific scope; the caller merely
0N/A * requests the fields to be activated.
0N/A *
0N/A * @xerces.internal
0N/A *
0N/A * @author Andy Clark, IBM
0N/A *
0N/A */
0N/Apublic interface FieldActivator {
0N/A
0N/A //
0N/A // FieldActivator methods
0N/A //
0N/A
0N/A /**
0N/A * Start the value scope for the specified identity constraint. This
0N/A * method is called when the selector matches in order to initialize
0N/A * the value store.
0N/A *
0N/A * @param identityConstraint The identity constraint.
0N/A * @param initialDepth the depth at which the selector began matching
0N/A */
0N/A public void startValueScopeFor(IdentityConstraint identityConstraint,
0N/A int initialDepth);
0N/A
0N/A /**
0N/A * Request to activate the specified field. This method returns the
0N/A * matcher for the field.
0N/A * It's also important for the implementor to ensure that it marks whether a Field
0N/A * is permitted to match a value--that is, to call the setMayMatch(Field, Boolean) method.
0N/A *
0N/A * @param field The field to activate.
0N/A * @param initialDepth the 0-indexed depth in the instance document at which the Selector began to match.
0N/A */
0N/A public XPathMatcher activateField(Field field, int initialDepth);
0N/A
0N/A /**
0N/A * Sets whether the given field is permitted to match a value.
0N/A * This should be used to catch instance documents that try
0N/A * and match a field several times in the same scope.
0N/A *
0N/A * @param field The field that may be permitted to be matched.
0N/A * @param state Boolean indiciating whether the field may be matched.
0N/A */
0N/A public void setMayMatch(Field field, Boolean state);
0N/A
0N/A /**
0N/A * Returns whether the given field is permitted to match a value.
0N/A *
0N/A * @param field The field that may be permitted to be matched.
0N/A * @return Boolean indicating whether the field may be matched.
0N/A */
0N/A public Boolean mayMatch(Field field);
0N/A
0N/A /**
0N/A * Ends the value scope for the specified identity constraint.
0N/A *
0N/A * @param identityConstraint The identity constraint.
0N/A * @param initialDepth the 0-indexed depth where the Selector began to match.
0N/A */
0N/A public void endValueScopeFor(IdentityConstraint identityConstraint, int initialDepth);
0N/A
0N/A} // interface FieldActivator
0N/A