annotation.h
Go to the documentation of this file.
00001 /*
00002  * Copyright 2006-2008 The FLWOR Foundation.
00003  *
00004  * Licensed under the Apache License, Version 2.0 (the "License");
00005  * you may not use this file except in compliance with the License.
00006  * You may obtain a copy of the License at
00007  *
00008  * http://www.apache.org/licenses/LICENSE-2.0
00009  *
00010  * Unless required by applicable law or agreed to in writing, software
00011  * distributed under the License is distributed on an "AS IS" BASIS,
00012  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00013  * See the License for the specific language governing permissions and
00014  * limitations under the License.
00015  */
00016 #ifndef ZORBA_ANNOTATION_API_H
00017 #define ZORBA_ANNOTATION_API_H
00018 
00019 #include <zorba/config.h>
00020 #include <zorba/api_shared_types.h>
00021 #include <zorba/smart_ptr.h>
00022 
00023 namespace zorba {
00024 
00025 class ZORBA_DLL_PUBLIC Annotation : public SmartObject
00026 {
00027  public:
00028   /** \brief Destructor
00029    */
00030   virtual ~Annotation() {}
00031   
00032   /**
00033    *  Returns the QName of the annotation
00034    */
00035   virtual Item
00036   getQName() const = 0;
00037 
00038   /**
00039    *  Returns the number of literals that are associated with the annotation,
00040    *  e.g. for the annotation:
00041    *
00042    *      %annotation(Literal1, Literal2, ..., LiteralN)
00043    *
00044    *  the function will return N.
00045    */
00046   virtual unsigned int
00047   getLiteralsCount() const = 0;
00048   
00049   /**
00050    *  Returns the requested literal. E.g. for the annotation
00051    *
00052    *      %annotation(Literal1, Literal2, ..., LiteralN)
00053    *
00054    *  the function will return the i-th literal.
00055    */
00056   virtual Item
00057   getLiteral(unsigned int i) const = 0;
00058 };
00059 
00060 } /* namespace zorba */
00061 #endif
00062 
00063 /*
00064  * Local variables:
00065  * mode: c++
00066  * End:
00067  */
00068 
00069 /* vim:set et sw=2 ts=2: */
blog comments powered by Disqus