1 /*
   2  * Copyright (c) 2005, 2015, Thai Open Source Software Center Ltd
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are
   7  * met:
   8  *
   9  *     Redistributions of source code must retain the above copyright
  10  *     notice, this list of conditions and the following disclaimer.
  11  *
  12  *     Redistributions in binary form must reproduce the above copyright
  13  *     notice, this list of conditions and the following disclaimer in
  14  *     the documentation and/or other materials provided with the
  15  *     distribution.
  16  *
  17  *     Neither the name of the Thai Open Source Software Center Ltd nor
  18  *     the names of its contributors may be used to endorse or promote
  19  *     products derived from this software without specific prior written
  20  *     permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  23  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  24  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  25  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR
  26  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  27  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  28  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  29  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  30  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  31  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  32  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  33  */
  34 
  35 package com.sun.xml.internal.org.relaxng.datatype;
  36 
  37 /**
  38  * An interface that must be implemented by caller to
  39  * provide context information that is necessary to
  40  * perform validation of some Datatypes.
  41  *
  42  * @author <a href="mailto:jjc@jclark.com">James Clark</a>
  43  * @author <a href="mailto:kohsuke.kawaguchi@sun.com">Kohsuke KAWAGUCHI</a>
  44  */
  45 public interface ValidationContext {
  46 
  47         /**
  48          * Resolves a namespace prefix to the corresponding namespace URI.
  49          *
  50          * This method is used for validating the QName type, for example.
  51          *
  52          * <p>
  53          * If the prefix is "" (empty string), it indicates
  54          * an unprefixed value. The callee
  55          * should resolve it as for an unprefixed
  56          * element, rather than for an unprefixed attribute.
  57          *
  58          * <p>
  59          * If the prefix is "xml", then the callee must resolve
  60          * this prefix into "http://www.w3.org/XML/1998/namespace",
  61          * as defined in the XML Namespaces Recommendation.
  62          *
  63          * @return
  64          *              namespace URI of this prefix.
  65          *              If the specified prefix is not declared,
  66          *              the implementation must return null.
  67          */
  68         String resolveNamespacePrefix( String prefix );
  69 
  70         /**
  71          * Returns the base URI of the context.  The null string may be returned
  72          * if no base URI is known.
  73          */
  74         String getBaseUri();
  75 
  76         /**
  77          * Checks if an unparsed entity is declared with the
  78          * specified name.
  79          *
  80          * @return
  81          *  true
  82          *              if the DTD has an unparsed entity declaration for
  83          *              the specified name.
  84          *  false
  85          *              otherwise.
  86          */
  87         boolean isUnparsedEntity( String entityName );
  88 
  89         /**
  90          * Checks if a notation is declared with the
  91          * specified name.
  92          *
  93          * @return
  94          *  true
  95          *              if the DTD has a notation declaration for the specified name.
  96          *  false
  97          *              otherwise.
  98          */
  99         boolean isNotation( String notationName );
 100 }