org.apache.xerces.impl.xs.identity

Interface FieldActivator

public interface FieldActivator

Interface for a field activator. The field activator is responsible for activating fields within a specific scope; the caller merely requests the fields to be activated.

Version: $Id: FieldActivator.java,v 1.7 2004/10/06 15:14:51 mrglavas Exp $

Author: Andy Clark, IBM

UNKNOWN:

Method Summary
XPathMatcheractivateField(Field field, int initialDepth)
Request to activate the specified field.
voidendValueScopeFor(IdentityConstraint identityConstraint, int initialDepth)
Ends the value scope for the specified identity constraint.
BooleanmayMatch(Field field)
Returns whether the given field is permitted to match a value.
voidsetMayMatch(Field field, Boolean state)
Sets whether the given field is permitted to match a value.
voidstartValueScopeFor(IdentityConstraint identityConstraint, int initialDepth)
Start the value scope for the specified identity constraint.

Method Detail

activateField

public XPathMatcher activateField(Field field, int initialDepth)
Request to activate the specified field. This method returns the matcher for the field. It's also important for the implementor to ensure that it marks whether a Field is permitted to match a value--that is, to call the setMayMatch(Field, Boolean) method.

Parameters: field The field to activate. initialDepth the 0-indexed depth in the instance document at which the Selector began to match.

endValueScopeFor

public void endValueScopeFor(IdentityConstraint identityConstraint, int initialDepth)
Ends the value scope for the specified identity constraint.

Parameters: identityConstraint The identity constraint. initialDepth the 0-indexed depth where the Selector began to match.

mayMatch

public Boolean mayMatch(Field field)
Returns whether the given field is permitted to match a value.

Parameters: field The field that may be permitted to be matched.

Returns: Boolean indicating whether the field may be matched.

setMayMatch

public void setMayMatch(Field field, Boolean state)
Sets whether the given field is permitted to match a value. This should be used to catch instance documents that try and match a field several times in the same scope.

Parameters: field The field that may be permitted to be matched. state Boolean indiciating whether the field may be matched.

startValueScopeFor

public void startValueScopeFor(IdentityConstraint identityConstraint, int initialDepth)
Start the value scope for the specified identity constraint. This method is called when the selector matches in order to initialize the value store.

Parameters: identityConstraint The identity constraint. initialDepth the depth at which the selector began matching

Copyright © 1999-2005 Apache XML Project. All Rights Reserved.