001: /*
002: * Licensed to the Apache Software Foundation (ASF) under one or more
003: * contributor license agreements. See the NOTICE file distributed with
004: * this work for additional information regarding copyright ownership.
005: * The ASF licenses this file to You under the Apache License, Version 2.0
006: * (the "License"); you may not use this file except in compliance with
007: * the License. You may obtain a copy of the License at
008: *
009: * http://www.apache.org/licenses/LICENSE-2.0
010: *
011: * Unless required by applicable law or agreed to in writing, software
012: * distributed under the License is distributed on an "AS IS" BASIS,
013: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014: * See the License for the specific language governing permissions and
015: * limitations under the License.
016: */
017: package org.apache.xerces.xpointer;
018:
019: import org.apache.xerces.xni.Augmentations;
020: import org.apache.xerces.xni.QName;
021: import org.apache.xerces.xni.XMLAttributes;
022: import org.apache.xerces.xni.XNIException;
023:
024: /**
025: * <p>
026: * Used for scheme specific parsing and evaluation of an XPointer expression.
027: * This interface applies to both ShortHand and SchemeBased XPointer
028: * expressions.
029: * </p>
030: *
031: * @xerces.internal
032: *
033: * @version $Id: XPointerPart.java 449487 2006-09-24 21:11:28Z mrglavas $
034: */
035: public interface XPointerPart {
036:
037: // The start element event
038: public static final int EVENT_ELEMENT_START = 0;
039:
040: // The end element event
041: public static final int EVENT_ELEMENT_END = 1;
042:
043: // The empty element event
044: public static final int EVENT_ELEMENT_EMPTY = 2;
045:
046: /**
047: * Provides scheme specific parsing of a XPointer expression i.e.
048: * the PointerPart or ShortHandPointer.
049: *
050: * @param part A String representing the PointerPart or ShortHandPointer.
051: * @throws XNIException Thrown if the PointerPart string does not conform to
052: * the syntax defined by its scheme.
053: *
054: */
055: public void parseXPointer(String part) throws XNIException;
056:
057: /**
058: * Evaluates an XML resource with respect to an XPointer expressions
059: * by checking if it's element and attributes parameters match the
060: * criteria specified in the xpointer expression.
061: *
062: * @param element - The name of the element.
063: * @param attributes - The element attributes.
064: * @param augs - Additional information that may include infoset augmentations
065: * @param event - An integer indicating
066: * 0 - The start of an element
067: * 1 - The end of an element
068: * 2 - An empty element call
069: * @throws XNIException Thrown to signal an error
070: *
071: */
072: public boolean resolveXPointer(QName element,
073: XMLAttributes attributes, Augmentations augs, int event)
074: throws XNIException;
075:
076: /**
077: * Returns true if the XPointer expression resolves to a resource fragment
078: * specified as input else returns false.
079: *
080: * @return True if the xpointer expression matches a fragment in the resource
081: * else returns false.
082: * @throws XNIException Thrown to signal an error
083: *
084: */
085: public boolean isFragmentResolved() throws XNIException;
086:
087: /**
088: * Returns true if the XPointer expression resolves to a non-element child
089: * of the current resource fragment.
090: *
091: * @return True if the XPointer expression resolves to a non-element child
092: * of the current resource fragment.
093: * @throws XNIException Thrown to signal an error
094: *
095: */
096: public boolean isChildFragmentResolved() throws XNIException;
097:
098: /**
099: * Returns a String containing the scheme name of the PointerPart
100: * or the name of the ShortHand Pointer.
101: *
102: * @return A String containing the scheme name of the PointerPart.
103: *
104: */
105: public String getSchemeName();
106:
107: /**
108: * Returns a String containing the scheme data of the PointerPart.
109: *
110: * @return A String containing the scheme data of the PointerPart.
111: *
112: */
113: public String getSchemeData();
114:
115: /**
116: * Sets the scheme name of the PointerPart or the ShortHand Pointer name.
117: *
118: * @param schemeName A String containing the scheme name of the PointerPart.
119: *
120: */
121: public void setSchemeName(String schemeName);
122:
123: /**
124: * Sets the scheme data of the PointerPart.
125: *
126: * @param schemeData A String containing the scheme data of the PointerPart.
127: *
128: */
129: public void setSchemeData(String schemeData);
130:
131: }
|