Namespaces | Classes | Typedefs | Enumerations | Functions
zorba Namespace Reference

Copyright 2006-2011 The FLWOR Foundation. More...

Namespaces

namespace  audit
namespace  diagnostic
namespace  encoding
namespace  err
namespace  fn
namespace  internal
namespace  locale
namespace  serialization
namespace  store
namespace  time
namespace  transcode
namespace  UnitTests
namespace  zerr
namespace  zfn
namespace  zwarn

Classes

class  Annotation
class  Collection
 A Collection is a persistent sequence of node items. More...
class  CollectionManager
 This class defines a set of functions for managing persistent collections. More...
class  ContextualExternalFunction
 The ContextualExternalFunction class serves as the base of subclasses that represent the implementation of contextual external functions. More...
class  DebuggerClient
 A DBGP client implementation for commands. More...
class  DebuggerEventHandler
class  DebuggerSocketException
 Signals a problem with the execution of a socket call. More...
class  DefaultContentHandler
 A default content handler class implementing the SAX2_ContentHandler and SAX2_LexicalHandler interfaces with all functions being implemented and doing nothing. More...
class  DefaultDebuggerEventHandler
class  Diagnostic
 A Diagnostic is the base class for all Zorba diagnostics (errors and warnings). More...
class  DiagnosticHandler
 When registered with an XQuery object, a DiagnosticHandler handles all exceptions and warnings that otherwise would have been thrown or reported. More...
class  DirectoryIterator
 This class is the representation of file system file. More...
class  DocumentManager
class  DynamicContext
 Instances of the class DynamicContext contain the information that is available at the time the query is executed. More...
class  EmptySequence
 This class is an implementation of the ItemSequence. More...
class  EntityData
 The class containing data which may be of use to URIMappers and URLResolvers when mapping/resolving a URI. More...
class  ExternalFunction
 The ExternalFunction class serves as the base of subclasses that represent the implementation/body of external functions. More...
class  ExternalFunctionParameter
 Instances of subclasses of this abstract class may be used as parameters to the DynamicContext::addExternalFunctionParameter function. More...
class  ExternalModule
 An external module represents a group of external functions, all belonging to the same target namespace. More...
class  file
class  File
 This class is the representation of file system file. More...
class  filesystem_path
class  Function
 The Function class represents a function that is callable from XQuery code, and it gives access to the various properties that are specified in the declaration of the function within a Prolog. More...
class  IdentTypes
class  Item
 The Zorba Item interface. More...
class  ItemFactory
 ItemFactory to create Items. More...
class  ItemSequence
 This interface represents an instance of the XQuery 1.0 and XPath 2.0 Data Model (XDM). More...
class  Iterator
 Interface for an Iterator over an instance of the XML Data Model (i.e., a sequence of items). More...
class  NonContextualExternalFunction
 The NonContextualExternalFunction class serves as the base of subclasses that represent the implementation of non contextual external functions. More...
class  OneToOneURIMapper
 Convenience implementation of a mapper that maps URIs to other single URIs. More...
class  PropertiesBase
class  PropertiesGlobal
 This class provides access to global properties. More...
class  QueryLocation
 Representation of the current location location in the remote query. More...
class  Resource
 The class representing the result of URL resolution. More...
class  SAX2_Attributes
class  SAX2_ContentHandler
 Receive notification of events that result from serializing a query result as XML. More...
class  SAX2_LexicalHandler
class  Sequence
 Provides a way for a function to return a sequence of some type T that can be iterated over. More...
class  SerializationCallback
class  Serializer
class  SingletonItemSequence
 A sequence that contains only one item. More...
class  SmartObject
class  SmartPtr
class  StackFrame
 Representation of the runtime stack frame. More...
class  StaticCollectionManager
 Using the StaticCollectionManager one can retrieve information about statically declared collections and indexes as well as manage them. More...
class  StaticContext
 Instances of the class StaticContext contain the information that is available at the time the query is compiled. More...
class  Stemmer
 A Stemmer is used to obtain the "stem" (root) word of of some word. More...
class  StemmerProvider
 A StemmerProvider, given a language, provides a Stemmer for it. More...
class  StoreManager
 Class contains helper functions to create and destroy the store that is to be used by the zorba library. More...
class  StreamResource
 Concrete Resource subclass representing access to an entity via a stream. More...
class  String
 The Zorba string class. More...
class  Thesaurus
 A Thesaurus provides a way to look up related phrases for a given phrase. More...
class  ThesaurusProvider
 A ThesaurusProvider is-a Resource for providing thesauri for a given language. More...
class  Tokenizer
 A Tokenizer breaks a string into a stream of word tokens. More...
class  TokenizerProvider
 A TokenizerProvider provides a Tokenizer for a given language. More...
class  TypeIdentifier
 Type identifiers. More...
class  URIHelper
 A helper class to do uri conversions. More...
class  URIMapper
 Interface for URI mapping. More...
class  URLResolver
 Interface for URL resolving. More...
class  UserError
 A UserError is-a Diagnostic for user-defined errors via fn:error(). More...
class  UserException
 A UserException is-an XQueryException for errors raised via fn:error(). More...
class  VectorItemSequence
 This class is an implementation of the ItemSequence. More...
class  Version
 Provide access to the version of Zorba that is used. More...
class  XmlDataManager
 Using the XmlDataManager one can manage documents and collections. More...
class  XQuery
 This class is the representation of an XQuery in the Zorba engine. More...
class  XQueryException
 An XQueryException is-a ZorbaException for errors with the user's XQuery. More...
class  XQueryStackTrace
class  Zorba
 The Zorba class is the single point of access to the Zorba engine. More...
class  ZorbaException
 A ZorbaException is the base class for all Zorba exceptions. More...

Typedefs

typedef zorba::SmartPtr
< Annotation
Annotation_t
typedef zorba::SmartPtr
< Collection
Collection_t
typedef zorba::SmartPtr
< DirectoryIterator
DirectoryIterator_t
typedef Diagnostic Error
typedef zorba::SmartPtr< FileFile_t
typedef zorba::SmartPtr< FunctionFunction_t
typedef
Zorba_SerializerOptions_t *(* 
itemHandler )(void *aUserData)
typedef zorba::SmartPtr
< ItemSequence
ItemSequence_t
typedef zorba::SmartPtr< IteratorIterator_t
typedef std::vector< std::pair
< String, String > > 
NsBindings
 Used for Item::getNamespaceBindings() and ItemFactory::createElementNode().
typedef internal::ztd::proxy
< std::streambuf > 
proxy_streambuf
typedef SmartPtr< QueryLocationQueryLocation_t
typedef zorba::SmartPtr
< Serializer
Serializer_t
typedef zorba::SmartPtr
< StaticContext
StaticContext_t
typedef zorba::SmartPtr
< TypeIdentifier
TypeIdentifier_t
typedef Diagnostic Warning
typedef zorba::SmartPtr< XQueryXQuery_t
typedef
internal::SystemDiagnostic
< internal::XQueryErrQName
XQueryErrorCode
 An XQueryErrorCode is a diagnostic for all XQuery-specific errors.
typedef XQueryException XQueryWarning
 Re-use an XQueryException as an XQueryWarning to:
typedef
internal::SystemDiagnostic
< internal::ZorbaErrQName
ZorbaErrorCode
 A ZorbaErrorCode is a diagnostic for all Zorba-specific errors.
typedef
internal::SystemDiagnostic
< internal::ZorbaWarningQName
ZorbaWarningCode
 A ZorbaWarningCode is a diagnostic for all Zorba-specific warnings.

Enumerations

enum  boundary_space_mode_t { preserve_space, strip_space }
 Boundary-space policy as defined in http://www.w3.org/TR/xquery/#static_context. More...
enum  construction_mode_t { preserve_cons, strip_cons }
 Construction mode as defined in http://www.w3.org/TR/xquery/#static_context. More...
enum  index_container_kind_t { index_hash, index_tree }
 Container kind of an index as defined in the XQuery Data Definition Facility. More...
enum  index_maintenance_mode_t { index_automatic, index_manual }
 Maintenance mode of an index as defined in the XQuery Data Definition Facility. More...
enum  inherit_mode_t { inherit_ns, no_inherit_ns }
 Inherit part of the Copy-namespace mode as defined in http://www.w3.org/TR/xquery/#static_context. More...
enum  order_empty_mode_t { empty_greatest, empty_least }
 Default order for empty sequences as defined in http://www.w3.org/TR/xquery/#static_context. More...
enum  ordering_mode_t { ordered, unordered }
 Ordering mode as defined in http://www.w3.org/TR/xquery/#static_context. More...
enum  preserve_mode_t { preserve_ns, no_preserve_ns }
 Preserve part of the Copy-namespace mode as defined in http://www.w3.org/TR/xquery/#static_context. More...
enum  validation_mode_t { validate_skip, validate_lax, validate_lax_dtd, validate_strict }
 Revalidation mode as defined in http://www.w3.org/TR/xquery-update-10/#id-revalidation-declaration Note: when DTD validation is needed the use of validate_lax_dtd is required. More...
enum  xpath1_0compatib_mode_t { xpath2_0, xpath1_0 }
 XPath 1.0 compatibility mode as defined in http://www.w3.org/TR/xquery/#static_context. More...
enum  xquery_version_t { xquery_version_1_0 = 100, xquery_version_3_0 = 300 }
 The XQuery version, taken from the version declaration, an XQuery 3.0 feature. More...

Functions

bool operator!= (Diagnostic const &d1, Diagnostic const &d2)
 Compares two diagnostics for inequality.
bool operator!= (String const &s1, String const &s2)
bool operator!= (String const &s1, std::string const &s2)
bool operator!= (String const &s1, String::const_pointer s2)
bool operator!= (std::string const &s1, String const &s2)
bool operator!= (String::const_pointer s1, String const &s2)
ZORBA_DLL_PUBLIC String operator+ (String const &s1, String const &s2)
ZORBA_DLL_PUBLIC String operator+ (String const &s1, std::string const &s2)
ZORBA_DLL_PUBLIC String operator+ (String const &s1, String::const_pointer s2)
ZORBA_DLL_PUBLIC String operator+ (std::string const &s1, String const &s2)
ZORBA_DLL_PUBLIC String operator+ (String::const_pointer s1, String const &s2)
ZORBA_DLL_PUBLIC bool operator< (String const &s1, String const &s2)
ZORBA_DLL_PUBLIC bool operator< (String const &s1, std::string const &s2)
ZORBA_DLL_PUBLIC bool operator< (String const &s1, String::const_pointer s2)
ZORBA_DLL_PUBLIC bool operator< (std::string const &s1, String const &s2)
ZORBA_DLL_PUBLIC bool operator< (String::const_pointer s1, String const &s2)
ZORBA_DLL_PUBLIC std::ostream & operator<< (std::ostream &os, const QueryLocation &aQuery)
ZORBA_DLL_PUBLIC std::ostream & operator<< (std::ostream &os, const QueryLocation *aQuery)
ZORBA_DLL_PUBLIC std::ostream & operator<< (std::ostream &os, const Version &aVersion)
 Write the result of calling aVersiongetVersion() to the given output stream.
std::ostream & operator<< (std::ostream &os, const filesystem_path &p)
std::ostream & operator<< (std::ostream &o, ZorbaException const &e)
 Emits the given ZorbaException to the given ostream.
ZORBA_DLL_PUBLIC std::ostream & operator<< (std::ostream &os, const XQuery_t &aQuery)
ZORBA_DLL_PUBLIC std::ostream & operator<< (std::ostream &os, XQuery *aQuery)
ZORBA_DLL_PUBLIC std::ostream & operator<< (std::ostream &o, String const &s)
ZORBA_DLL_PUBLIC bool operator<= (String const &s1, String const &s2)
ZORBA_DLL_PUBLIC bool operator<= (String const &s1, std::string const &s2)
ZORBA_DLL_PUBLIC bool operator<= (String const &s1, String::const_pointer s2)
ZORBA_DLL_PUBLIC bool operator<= (std::string const &s1, String const &s2)
ZORBA_DLL_PUBLIC bool operator<= (String::const_pointer s1, String const &s2)
bool operator== (Diagnostic const &d1, Diagnostic const &d2)
 Compares two diagnostics for equality.
ZORBA_DLL_PUBLIC bool operator== (String const &s1, String const &s2)
ZORBA_DLL_PUBLIC bool operator== (String const &s1, std::string const &s2)
ZORBA_DLL_PUBLIC bool operator== (String const &s1, String::const_pointer s2)
bool operator== (std::string const &s1, String const &s2)
bool operator== (String::const_pointer s1, String const &s2)
bool operator> (String const &s1, String const &s2)
bool operator> (String const &s1, std::string const &s2)
bool operator> (String const &s1, String::const_pointer s2)
bool operator> (std::string const &s1, String const &s2)
bool operator> (String::const_pointer s1, String const &s2)
bool operator>= (String const &s1, String const &s2)
bool operator>= (String const &s1, std::string const &s2)
bool operator>= (String const &s1, String::const_pointer s2)
bool operator>= (std::string const &s1, String const &s2)
bool operator>= (String::const_pointer s1, String const &s2)

Detailed Description

Copyright 2006-2011 The FLWOR Foundation.

This header includes utility functions for certain timing-related operations, namely getting current wall-clock time and current CPU-used time values in a platform-dependent fashion, and computing deltas for both types.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Types: cputime - type representing CPU time utilized thus far by this process walltime - type representing wall-clock time since some platform-dependent epoch

Function signatures: void get_current_cputime(cputime& t) - returns current CPU time

double get_cputime_elapsed(const cputime& t0, const cputime& t1) - calculates elapsed CPU time (in ms) between two cputimes

void get_current_walltime(walltime& t) - returns current wall-clock time

double get_walltime_elapsed(const walltime& t0, const walltime& t1) - calculates elapsed wall-clock time (in ms) between two walltimes TODO These functions should probably be defined in a .cpp file somewhere rather than here in time.h; as it is they will be compiled into every .o that uses them. So far, though, this is only zorbacmd and the implementation of fn:doc(), so it's not too bad.


Typedef Documentation

Definition at line 65 of file api_shared_types.h.

Definition at line 63 of file api_shared_types.h.

Definition at line 67 of file api_shared_types.h.

Definition at line 33 of file error.h.

Definition at line 66 of file api_shared_types.h.

Definition at line 64 of file api_shared_types.h.

typedef Zorba_SerializerOptions_t*(* zorba::itemHandler)(void *aUserData)

Definition at line 29 of file xquery.h.

Examples:
external_functions.cpp.

Definition at line 69 of file api_shared_types.h.

Definition at line 61 of file api_shared_types.h.

typedef std::vector<std::pair<String, String> > zorba::NsBindings

Used for Item::getNamespaceBindings() and ItemFactory::createElementNode().

Definition at line 39 of file item.h.

Definition at line 30 of file transcode_stream.h.

Definition at line 50 of file api_shared_types.h.

Definition at line 68 of file api_shared_types.h.

Definition at line 60 of file api_shared_types.h.

Definition at line 62 of file api_shared_types.h.

Definition at line 28 of file xquery_warning.h.

Definition at line 55 of file api_shared_types.h.

An XQueryErrorCode is a diagnostic for all XQuery-specific errors.

Definition at line 38 of file error.h.

Re-use an XQueryException as an XQueryWarning to:

  • leverage all the localization and printing code
  • allow warnings to be treated as exceptions and thrown

Definition at line 41 of file xquery_warning.h.

A ZorbaErrorCode is a diagnostic for all Zorba-specific errors.

Definition at line 43 of file error.h.

A ZorbaWarningCode is a diagnostic for all Zorba-specific warnings.

Definition at line 34 of file xquery_warning.h.


Enumeration Type Documentation

Boundary-space policy as defined in http://www.w3.org/TR/xquery/#static_context.

Enumerator:
preserve_space 
strip_space 

Definition at line 48 of file static_context_consts.h.

Construction mode as defined in http://www.w3.org/TR/xquery/#static_context.

Enumerator:
preserve_cons 
strip_cons 

Definition at line 52 of file static_context_consts.h.

Container kind of an index as defined in the XQuery Data Definition Facility.

Enumerator:
index_hash 
index_tree 

Definition at line 72 of file static_context_consts.h.

Maintenance mode of an index as defined in the XQuery Data Definition Facility.

Enumerator:
index_automatic 
index_manual 

Definition at line 67 of file static_context_consts.h.

Inherit part of the Copy-namespace mode as defined in http://www.w3.org/TR/xquery/#static_context.

Enumerator:
inherit_ns 
no_inherit_ns 

Definition at line 39 of file static_context_consts.h.

Default order for empty sequences as defined in http://www.w3.org/TR/xquery/#static_context.

Enumerator:
empty_greatest 
empty_least 

Definition at line 34 of file static_context_consts.h.

Ordering mode as defined in http://www.w3.org/TR/xquery/#static_context.

Enumerator:
ordered 
unordered 

Definition at line 29 of file static_context_consts.h.

Preserve part of the Copy-namespace mode as defined in http://www.w3.org/TR/xquery/#static_context.

Enumerator:
preserve_ns 
no_preserve_ns 

Definition at line 44 of file static_context_consts.h.

Revalidation mode as defined in http://www.w3.org/TR/xquery-update-10/#id-revalidation-declaration Note: when DTD validation is needed the use of validate_lax_dtd is required.

Enumerator:
validate_skip 
validate_lax 
validate_lax_dtd 
validate_strict 

Definition at line 62 of file static_context_consts.h.

XPath 1.0 compatibility mode as defined in http://www.w3.org/TR/xquery/#static_context.

Enumerator:
xpath2_0 
xpath1_0 

Definition at line 25 of file static_context_consts.h.

The XQuery version, taken from the version declaration, an XQuery 3.0 feature.

Enumerator:
xquery_version_1_0 
xquery_version_3_0 

Definition at line 56 of file static_context_consts.h.


Function Documentation

bool zorba::operator!= ( Diagnostic const &  d1,
Diagnostic const &  d2 
)
inline

Compares two diagnostics for inequality.

Parameters:
d1The first diagnostic.
d2The second diagnostic.
Returns:
Returns true only if the diagnostics' QNames are not equal.

Definition at line 381 of file diagnostic.h.

bool zorba::operator!= ( String const &  s1,
String const &  s2 
)
inline

Definition at line 1350 of file zorba_string.h.

bool zorba::operator!= ( String const &  s1,
std::string const &  s2 
)
inline

Definition at line 1354 of file zorba_string.h.

bool zorba::operator!= ( String const &  s1,
String::const_pointer  s2 
)
inline

Definition at line 1358 of file zorba_string.h.

bool zorba::operator!= ( std::string const &  s1,
String const &  s2 
)
inline

Definition at line 1362 of file zorba_string.h.

bool zorba::operator!= ( String::const_pointer  s1,
String const &  s2 
)
inline

Definition at line 1366 of file zorba_string.h.

ZORBA_DLL_PUBLIC String zorba::operator+ ( String const &  s1,
String const &  s2 
)
ZORBA_DLL_PUBLIC String zorba::operator+ ( String const &  s1,
std::string const &  s2 
)
ZORBA_DLL_PUBLIC String zorba::operator+ ( String const &  s1,
String::const_pointer  s2 
)
ZORBA_DLL_PUBLIC String zorba::operator+ ( std::string const &  s1,
String const &  s2 
)
ZORBA_DLL_PUBLIC String zorba::operator+ ( String::const_pointer  s1,
String const &  s2 
)
ZORBA_DLL_PUBLIC bool zorba::operator< ( String const &  s1,
String const &  s2 
)
ZORBA_DLL_PUBLIC bool zorba::operator< ( String const &  s1,
std::string const &  s2 
)
ZORBA_DLL_PUBLIC bool zorba::operator< ( String const &  s1,
String::const_pointer  s2 
)
ZORBA_DLL_PUBLIC bool zorba::operator< ( std::string const &  s1,
String const &  s2 
)
ZORBA_DLL_PUBLIC bool zorba::operator< ( String::const_pointer  s1,
String const &  s2 
)
ZORBA_DLL_PUBLIC std::ostream& zorba::operator<< ( std::ostream &  os,
const QueryLocation &  aQuery 
)
ZORBA_DLL_PUBLIC std::ostream& zorba::operator<< ( std::ostream &  os,
const QueryLocation *  aQuery 
)
ZORBA_DLL_PUBLIC std::ostream& zorba::operator<< ( std::ostream &  os,
const Version &  aVersion 
)

Write the result of calling aVersiongetVersion() to the given output stream.

std::ostream& zorba::operator<< ( std::ostream &  os,
const filesystem_path &  p 
)
inline

Definition at line 93 of file path.h.

References zorba::filesystem_path::get_path().

std::ostream& zorba::operator<< ( std::ostream &  o,
ZorbaException const &  e 
)
inline

Emits the given ZorbaException to the given ostream.

Parameters:
oThe ostream to emit to.
eThe ZorbaException to emit.
Returns:
Returns o.

Definition at line 174 of file zorba_exception.h.

References zorba::ZorbaException::print().

ZORBA_DLL_PUBLIC std::ostream& zorba::operator<< ( std::ostream &  os,
const XQuery_t &  aQuery 
)
ZORBA_DLL_PUBLIC std::ostream& zorba::operator<< ( std::ostream &  os,
XQuery *  aQuery 
)
ZORBA_DLL_PUBLIC std::ostream& zorba::operator<< ( std::ostream &  o,
String const &  s 
)
ZORBA_DLL_PUBLIC bool zorba::operator<= ( String const &  s1,
String const &  s2 
)
ZORBA_DLL_PUBLIC bool zorba::operator<= ( String const &  s1,
std::string const &  s2 
)
ZORBA_DLL_PUBLIC bool zorba::operator<= ( String const &  s1,
String::const_pointer  s2 
)
ZORBA_DLL_PUBLIC bool zorba::operator<= ( std::string const &  s1,
String const &  s2 
)
ZORBA_DLL_PUBLIC bool zorba::operator<= ( String::const_pointer  s1,
String const &  s2 
)
bool zorba::operator== ( Diagnostic const &  d1,
Diagnostic const &  d2 
)
inline

Compares two diagnostics for equality.

Parameters:
d1The first diagnostic.
d2The second diagnostic.
Returns:
Returns true only if the diagnostics' QNames are equal.

Definition at line 370 of file diagnostic.h.

References zorba::Diagnostic::qname().

ZORBA_DLL_PUBLIC bool zorba::operator== ( String const &  s1,
String const &  s2 
)
ZORBA_DLL_PUBLIC bool zorba::operator== ( String const &  s1,
std::string const &  s2 
)
ZORBA_DLL_PUBLIC bool zorba::operator== ( String const &  s1,
String::const_pointer  s2 
)
bool zorba::operator== ( std::string const &  s1,
String const &  s2 
)
inline

Definition at line 1342 of file zorba_string.h.

bool zorba::operator== ( String::const_pointer  s1,
String const &  s2 
)
inline

Definition at line 1346 of file zorba_string.h.

bool zorba::operator> ( String const &  s1,
String const &  s2 
)
inline

Definition at line 1390 of file zorba_string.h.

bool zorba::operator> ( String const &  s1,
std::string const &  s2 
)
inline

Definition at line 1394 of file zorba_string.h.

bool zorba::operator> ( String const &  s1,
String::const_pointer  s2 
)
inline

Definition at line 1398 of file zorba_string.h.

bool zorba::operator> ( std::string const &  s1,
String const &  s2 
)
inline

Definition at line 1402 of file zorba_string.h.

bool zorba::operator> ( String::const_pointer  s1,
String const &  s2 
)
inline

Definition at line 1406 of file zorba_string.h.

bool zorba::operator>= ( String const &  s1,
String const &  s2 
)
inline

Definition at line 1370 of file zorba_string.h.

bool zorba::operator>= ( String const &  s1,
std::string const &  s2 
)
inline

Definition at line 1374 of file zorba_string.h.

bool zorba::operator>= ( String const &  s1,
String::const_pointer  s2 
)
inline

Definition at line 1378 of file zorba_string.h.

bool zorba::operator>= ( std::string const &  s1,
String const &  s2 
)
inline

Definition at line 1382 of file zorba_string.h.

bool zorba::operator>= ( String::const_pointer  s1,
String const &  s2 
)
inline

Definition at line 1386 of file zorba_string.h.

blog comments powered by Disqus