Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.6

Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

KeyDeclaration.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  *
00005  * Copyright (c) 1999-2002 The Apache Software Foundation.  All rights 
00006  * reserved.
00007  *
00008  * Redistribution and use in source and binary forms, with or without
00009  * modification, are permitted provided that the following conditions
00010  * are met:
00011  *
00012  * 1. Redistributions of source code must retain the above copyright
00013  *    notice, this list of conditions and the following disclaimer. 
00014  *
00015  * 2. Redistributions in binary form must reproduce the above copyright
00016  *    notice, this list of conditions and the following disclaimer in
00017  *    the documentation and/or other materials provided with the
00018  *    distribution.
00019  *
00020  * 3. The end-user documentation included with the redistribution,
00021  *    if any, must include the following acknowledgment:  
00022  *       "This product includes software developed by the
00023  *        Apache Software Foundation (http://www.apache.org/)."
00024  *    Alternately, this acknowledgment may appear in the software itself,
00025  *    if and wherever such third-party acknowledgments normally appear.
00026  *
00027  * 4. The names "Xalan" and "Apache Software Foundation" must
00028  *    not be used to endorse or promote products derived from this
00029  *    software without prior written permission. For written 
00030  *    permission, please contact apache@apache.org.
00031  *
00032  * 5. Products derived from this software may not be called "Apache",
00033  *    nor may "Apache" appear in their name, without prior written
00034  *    permission of the Apache Software Foundation.
00035  *
00036  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
00037  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00038  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00039  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
00040  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00041  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00042  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
00043  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00044  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00045  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00046  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00047  * SUCH DAMAGE.
00048  * ====================================================================
00049  *
00050  * This software consists of voluntary contributions made by many
00051  * individuals on behalf of the Apache Software Foundation and was
00052  * originally based on software copyright (c) 1999, International
00053  * Business Machines, Inc., http://www.ibm.com.  For more
00054  * information on the Apache Software Foundation, please see
00055  * <http://www.apache.org/>.
00056  */
00057 #if !defined(XALAN_KEYDECLARATION_HEADER_GUARD)
00058 #define XALAN_KEYDECLARATION_HEADER_GUARD
00059 
00060 
00061 
00062 // Base include file.  Must be first.
00063 #include "XSLTDefinitions.hpp"
00064 
00065 
00066 
00067 XALAN_CPP_NAMESPACE_BEGIN
00068 
00069 
00070 
00071 #include <xalanc/PlatformSupport/XalanLocator.hpp>
00072 
00073 
00074 
00075 class XPath;
00076 
00077 
00078 
00082 class KeyDeclaration
00083 {
00084 public:
00085 
00093     KeyDeclaration(
00094             const XalanQName&           qname,
00095             const XPath&                matchPattern,
00096             const XPath&                use,
00097             const XalanDOMString&       uri,
00098             XalanLocator::size_type     lineNumber,
00099             XalanLocator::size_type     columnNumber) :
00100         m_qname(&qname),
00101         m_match(&matchPattern),
00102         m_use(&use),
00103         m_uri(&uri),
00104         m_lineNumber(lineNumber),
00105         m_columnNumber(columnNumber)
00106     {
00107     }
00108 
00109     explicit
00110     KeyDeclaration() :
00111         m_qname(0),
00112         m_match(0),
00113         m_use(0),
00114         m_uri(0),
00115         m_lineNumber(0),
00116         m_columnNumber(0)
00117     {
00118     }
00119 
00120     KeyDeclaration(const KeyDeclaration&    theSource) :
00121         m_qname(theSource.m_qname),
00122         m_match(theSource.m_match),
00123         m_use(theSource.m_use)
00124     {
00125     }
00126 
00127     ~KeyDeclaration()
00128     {
00129     }
00130 
00136     const XalanQName*
00137     getQName() const
00138     {
00139         return m_qname;
00140     }
00141 
00147     const XPath*
00148     getUse() const
00149     {
00150         return m_use;
00151     }
00152 
00158     const XPath*
00159     getMatchPattern() const
00160     {
00161         return m_match;
00162     }
00163 
00169     const XalanDOMString*
00170     getURI() const
00171     {
00172         return m_uri;
00173     }
00174 
00180     XalanLocator::size_type
00181     getLineNumber() const
00182     {
00183         return m_lineNumber;
00184     }
00185 
00191     XalanLocator::size_type
00192     getColumnNumber() const
00193     {
00194         return m_columnNumber;
00195     }
00196 
00197 private:
00198 
00199     const XalanQName*           m_qname;
00200 
00201     const XPath*                m_match;
00202 
00203     const XPath*                m_use;
00204 
00205     const XalanDOMString*       m_uri;
00206 
00207     XalanLocator::size_type     m_lineNumber;
00208 
00209     XalanLocator::size_type     m_columnNumber;
00210 };
00211 
00212 
00213 
00214 XALAN_CPP_NAMESPACE_END
00215 
00216 
00217 
00218 #endif  // XALAN_KEYDECLARATION_HEADER_GUARD

Interpreting class diagrams

Doxygen and GraphViz are used to generate this API documentation from the Xalan-C header files.

Xalan-C++ XSLT Processor Version 1.6
Copyright © 2000, 2001, 2002, 2003 The Apache Software Foundation. All Rights Reserved.