001: /*
002: * The Apache Software License, Version 1.1
003: *
004: *
005: * Copyright (c) 2000 The Apache Software Foundation. All rights
006: * 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.common;
059:
060: import java.util.*;
061: import org.apache.xerces.validators.common.Grammar;
062: import org.apache.xerces.validators.datatype.DatatypeValidatorFactory;
063:
064: /**
065: * This class embodies the representation of a Grammar
066: * pool Resolver.
067: * This class is called from the validator.
068: *
069: *
070: * @author Jeffrey Rodriguez
071: */
072:
073: public interface GrammarResolver {
074: /**
075: * initializeGrammarRegistry - Gets call to register initial
076: * grammars such as DTD - Schema
077: */
078:
079: /**
080: *
081: * @param nameSpaceKey
082: * Namespace key into Grammar pool
083: * @return Grammar abstraction associated
084: * with NameSpace key.
085: */
086: public Grammar getGrammar(String nameSpaceKey);
087:
088: public DatatypeValidatorFactory getDatatypeRegistry();
089:
090: /**
091: *
092: * @return Enumeration of String key name spaces in Grammar pool
093: */
094:
095: public Enumeration nameSpaceKeys();
096:
097: /**
098: *
099: * @param nameSpaceKey
100: * Key to associate with Grammar
101: * abstraction
102: * @param grammar Grammar abstraction
103: * used by validator.
104: */
105: public void putGrammar(String nameSpaceKey, Grammar grammar);
106:
107: /**
108: * Removes association of Namespace key and Grammar from
109: * Grammar pool
110: *
111: * @param nameSpaceKey
112: * Name space key
113: */
114: public Grammar removeGrammar(String nameSpaceKey);
115:
116: /**
117: * Is Grammar abstraction in Grammar pool?
118: *
119: * @param grammar Grammar Abstraction
120: * @return true - Yes there is at least one instance
121: * false - No
122: */
123: public boolean contains(Grammar grammar);
124:
125: /**
126: * Is Namespace key in Grammar pool
127: *
128: * @param nameSpaceKey
129: * Namespace key
130: * @return Boolean- true - Namespace key association
131: * is in grammar pool.
132: */
133: public boolean containsNameSpace(String nameSpaceKey);
134:
135: /**
136: * Reset internal Namespace/Grammar registry.
137: */
138: public void clearGrammarResolver();
139:
140: /**
141: *
142: * @return Length of grammar pool. Number of associations.
143: */
144: public int size();
145:
146: }
|