001: /*
002: * The Apache Software License, Version 1.1
003: *
004: *
005: * Copyright (c) 2001 The Apache Software Foundation.
006: * All rights reserved.
007: *
008: * Redistribution and use in source and binary forms, with or without
009: * modification, are permitted provided that the following conditions
010: * are met:
011: *
012: * 1. Redistributions of source code must retain the above copyright
013: * notice, this list of conditions and the following disclaimer.
014: *
015: * 2. Redistributions in binary form must reproduce the above copyright
016: * notice, this list of conditions and the following disclaimer in
017: * the documentation and/or other materials provided with the
018: * distribution.
019: *
020: * 3. The end-user documentation included with the redistribution,
021: * if any, must include the following acknowledgment:
022: * "This product includes software developed by the
023: * Apache Software Foundation (http://www.apache.org/)."
024: * Alternately, this acknowledgment may appear in the software itself,
025: * if and wherever such third-party acknowledgments normally appear.
026: *
027: * 4. The names "Xerces" and "Apache Software Foundation" must
028: * not be used to endorse or promote products derived from this
029: * software without prior written permission. For written
030: * permission, please contact apache@apache.org.
031: *
032: * 5. Products derived from this software may not be called "Apache",
033: * nor may "Apache" appear in their name, without prior written
034: * permission of the Apache Software Foundation.
035: *
036: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
037: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
038: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
039: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
040: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
041: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
042: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
043: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
044: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
045: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
046: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
047: * SUCH DAMAGE.
048: * ====================================================================
049: *
050: * This software consists of voluntary contributions made by many
051: * individuals on behalf of the Apache Software Foundation and was
052: * originally based on software copyright (c) 1999, International
053: * Business Machines, Inc., http://www.apache.org. For more
054: * information on the Apache Software Foundation, please see
055: * <http://www.apache.org/>.
056: */
057:
058: package org.apache.xerces.validators.schema.identity;
059:
060: import org.xml.sax.SAXException;
061:
062: /**
063: * Interface for a field activator. The field activator is responsible
064: * for activating fields within a specific scope; the caller merely
065: * requests the fields to be activated.
066: *
067: * @author Andy Clark, IBM
068: *
069: * @version $Id: FieldActivator.java,v 1.3 2001/06/14 22:23:43 neilg Exp $
070: */
071: public interface FieldActivator {
072:
073: //
074: // FieldActivator methods
075: //
076:
077: /**
078: * Start the value scope for the specified identity constraint. This
079: * method is called when the selector matches in order to initialize
080: * the value store.
081: *
082: * @param identityConstraint The identity constraint.
083: */
084: public void startValueScopeFor(IdentityConstraint identityConstraint)
085: throws Exception;
086:
087: /**
088: * Request to activate the specified field. This method returns the
089: * matcher for the field.
090: * It's also important for the implementor to ensure that the Field realizes that
091: * it is permitted to match a value--that is, to call the field's setMayMatch(boolean) method.
092: *
093: * @param field The field to activate.
094: */
095: public XPathMatcher activateField(Field field) throws Exception;
096:
097: /**
098: * Ends the value scope for the specified identity constraint.
099: *
100: * @param identityConstraint The identity constraint.
101: */
102: public void endValueScopeFor(IdentityConstraint identityConstraint)
103: throws Exception;
104:
105: } // interface FieldActivator
|