Qizx fe-4.4p2 API

Uses of Class
com.qizx.api.DataModelException

Packages that use DataModelException
com.qizx.api API of the embeddable version of the Qizx XML Query engine. 
com.qizx.api.util Utility classes implementing interfaces from the API, in particular conversion to XML, HTML, DOM, SAX, conversion from DOM and SAX, and connection to JAXP-compatible XSLT engines. 
com.qizx.api.util.fulltext This package contains the built-in implementation of full-text features. 
com.qizx.api.util.text Text-related utility classes, in particular implementations of base indexing Sieves. 
com.qizx.apps.restapi HTTP client for the Qizx REST API. 
 

Uses of DataModelException in com.qizx.api
 

Subclasses of DataModelException in com.qizx.api
 class AccessControlException
          Exception thrown when an AccessControl denies a User the permission to read or modify information in Library.
 class LibraryException
          A specific class of DataModelException raised by Library operations.
 

Methods in com.qizx.api that throw DataModelException
 void Library.backup(File backupDir)
          Makes a snapshot copy of the Library to a directory.
 XMLPushStream Library.beginImportDocument(String documentPath)
          Document import primitive: returns a push-style interface allowing storing a document from a source other than a parser.
 void Expression.bindImplicitCollection(LibraryMember root)
          Defines the Implicit Collection, as a Collection or Document.
 void Expression.bindImplicitCollection(LibraryMemberIterator roots)
          Defines the Implicit Collection as a set of Documents defined by a query.
 void Library.cancelImportDocument()
          Cancels a document import initiated by beginImportDocument.
 boolean LibraryManager.closeAllLibraries(int graceTimeMillis)
          Shuts down the manager by unmanaging all the Libraries and releasing resources.
 void ContentImporter.configure(Properties options)
          Configure with implementation-specific properties.
 boolean Node.contains(Node node)
          Returns true if this node is an ancestor of the parameter node or the node itself.
 LibraryMember Library.copyMember(String srcPath, String dstPath)
          Copies the specified member of the Library (Document or Collection).
 void LibraryMember.copyTo(String newPath)
          Copies the Document or Collection to another location.
 com.qizx.api.util.backup.BackupTarget LibraryManager.createBackup(File location, String libraryName, int version, boolean incremental)
          Opens or creates a Library used as backup output.
 Collection Collection.createChildCollection(String name)
          Creates a Collection direct child of this collection.
 Collection Library.createCollection(String absolutePath)
          Creates a new Collection.
 LibraryMemberIterator PostCommitTrigger.CommitEvent.createdDocuments()
          Returns an iterator on documents created in the transaction.
 boolean Node.deepEquals(Node node, Collator collator)
          Deep equality of two subtrees.
 void LibraryMember.delete()
          Deletes the Document or Collection.
 LibraryMemberIterator PostCommitTrigger.CommitEvent.deletedDocuments()
          Returns an iterator on documents deleted in the transaction.
 boolean Library.deleteMember(String path)
          Deletes the specified member of the Library.
 int Node.documentOrderCompareTo(Node that)
          Compares the document order of two nodes.
 Document Library.endImportDocument()
          Document import primitive: finishes a document import started with beginImportDocument() and returns a Document descriptor.
 XMLPullStream Document.export()
          Streaming export in pull mode.
 void Document.export(XMLPushStream output)
          Streaming export in push mode.
 void Indexing.export(XMLPushStream stream)
          Converts to an external representation.
 void XMLPushStream.flush()
          Optional flush of the output flow.
 Object Node.getAtomValue()
          Returns the value of an atomic node.
 Node Node.getAttribute(QName name)
          Gets an attribute of an element by name.
 int Node.getAttributeCount()
          Returns the number of attributes of an Element.
 Node[] Node.getAttributes()
          Gets the attributes of an element.
 String Node.getBaseURI()
          Return the base-URI of this Node.
 char[] Node.getCharValue()
          Returns the String Value of this leaf Node as a char array.
 LibraryMember Collection.getChild(String name)
          Returns the direct child of this collection (Document or Collection) that bears this name.
 LibraryMemberIterator Collection.getChildren()
          Returns an iterator over members (Documents and Collections) directly contained in this Collection.
 LibraryMemberIterator Collection.getChildren(LibraryMemberFilter filter)
          Returns an iterator over members directly contained in this Collection and accepted by the specified filter.
 Collection Library.getCollection(String absolutePath)
          Gets a Collection by its path inside the Library.
 Document PostCommitTrigger.CommitEvent.getCreatedDocument(String path)
          Returns the Document descriptor corresponding to this path if and only if this document has been created in the related commit.
 Document PostCommitTrigger.CommitEvent.getDeletedDocument(String path)
          Returns the Document descriptor corresponding to this path if and only if this document has been deleted in the related commit.
 Document Library.getDocument(String absolutePath)
          Gets a Document by its path inside the Library.
 Node Node.getDocumentNode()
          Returns the document node if any, else the top-level node.
 Node Document.getDocumentNode()
          Returns the root Node of the document, of type document-node().
 String Node.getDocumentURI()
          Returns the URI of the document.
 Node Node.getFirstChild()
          Returns the first child node of an element or a document node.
 Indexing Library.getIndexing()
          Gets the current indexing rules.
 long LibraryMember.getIntegerProperty(String propName)
          Convenience method: returns the integer value of a property.
 Document Node.getLibraryDocument()
          Returns the XML Library Document the Node belongs to, if applicable.
 long Node.getLongAtomValue()
          Returns the node contents as an integer value.
 LibraryMember Library.getMember(String absolutePath)
          Returns the specified member (Document or Collection) or null if such member does not exist.
 String Node.getNamespacePrefix(String nsURI)
          Returns a matching prefix for the Namespace URI by looking up the in-scope namespace definitions.
 String Node.getNamespaceUri(String prefix)
          Returns a matching Namespace for the prefix by looking up the in-scope namespace definitions.
 Node Node.getNextNode()
          Returns the next Node in document order.
 Node Node.getNextSibling()
          Returns the next sibling Node.
 String Node.getNodeKind()
          Returns the node kind as a string: "document", "element", "attribute", "text", "comment", or "processing-instruction".
 QName Node.getNodeName()
          Returns the Qualified Name of the node.
 int Node.getNodeNature()
          Returns a node kind in numeric form: DOCUMENT, ELEMENT etc.
 NonXMLDocument Library.getNonXMLDocument(String absolutePath)
          Gets a non-XML Document by its path inside the Library.
 Node Node.getParent()
          Returns the parent node.
 Collection LibraryMember.getParent()
          Returns the Collection that directly contains this member.
 Object LibraryMember.getProperty(String propName)
          Gets the value of a property by its name.
 String[] LibraryMember.getPropertyNames()
          Returns a sorted list of current property names of the object.
 Collection Library.getRootCollection()
          Returns the root collection of the Library.
 String Node.getStringValue()
          Returns the String Value of this Node.
 Collection PostCommitTrigger.CommitEvent.getUpdatedCollection(String path)
          Returns a non-null Collection descriptor if the collection with this path has been updated (i.e anything nested within the collection has changed).
 Document PostCommitTrigger.CommitEvent.getUpdatedDocument(String path)
          Returns the Document descriptor corresponding to this path if and only if this document has been updated in the related commit.
 boolean LibraryMember.hasProperty(String propName)
          Tests if this member has a property of the specified name.
 Document Library.importDocument(String documentPath, ContentImporter importer)
          Imports a Document into the Library by using an implementation of ImportMethod.
 Document Library.importDocument(String documentPath, File file)
          Imports a Document into the Library by parsing XML text from a File.
 Document Library.importDocument(String documentPath, InputSource source)
          Imports a Document into the Library by parsing a SAX InputSource.
 Document Library.importDocument(String documentPath, InputSource source, XMLReader xmlReader)
          Imports a Document into the Library by parsing a SAX InputSource, using a custom XML parser.
 Document Library.importDocument(String documentPath, String data)
          Imports a Document into the Library by parsing a string representing a XML fragment.
 Document Library.importDocument(String documentPath, URL url)
          Imports a Document into the Library by parsing XML text from an URL.
 NonXMLDocument Library.importNonXMLDocument(String path, boolean compress, InputStream source)
          Imports a non-XML document into the Library by reading from an InputStream.
 void Library.incrementalBackup(File backupDir)
          Makes a snapshot copy of the Library to a directory, transferring only the modified portions of the Library.
 boolean NonXMLDocument.isCompressed()
          Returns true if the contained data is compressed.
 boolean Node.isElement()
          Returns true if the Node is an Element.
 String[] LibraryManager.listLibraries()
          Returns the names of XML Libraries managed by this object.
 boolean LibraryMember.lock(int timeoutMillis)
          Starts an update transaction by locking this member (Document or Collection).
 boolean Library.lock(String[] memberPaths, int timeOutMillis)
          Locks one or several Collections or Documents to initiate a safe concurrent update.
 Collection Library.lockCollection(String path, int timeOutMillis)
          Locks a Collection to initiate a safe concurrent update.
 Document Library.lockDocument(String path, int timeOutMillis)
          Locks a Document to initiate a safe concurrent update.
 int XMLPullStream.moveToNextEvent()
          Moves the event stream one step forward.
 InputStream NonXMLDocument.open()
          Opens for sequential read.
 com.qizx.api.util.backup.BackupSession LibraryManager.openForBackup(String libraryName)
          Opens a backup session on a Library: a BackupSession is the source of a backup operation and allows comparison of contents with a BackupTarget in order to perform incremental backup or Replication.
 Library LibraryManager.openLibrary(String libraryName)
          Opens a new session on a Library.
 Library LibraryManager.openLibrary(String libraryName, AccessControl accessControl, User user)
          Opens a new session on a Library.
 void Library.optimize()
          Optimizes the underlying Library storage, in particular the indexes.
 void Indexing.parse(Node specification)
          Parses an Indexing specification from a Node.
 void ContentImporter.parse(XMLPushStream handler, String documentPath)
          Actual import work.
 void XMLPushStream.putAtom(Object value)
          Puts an atom value event.
 void XMLPushStream.putAttribute(QName name, String value, String attrType)
          Puts an Attribute event for the current element.
 void XMLPushStream.putChars(char[] text, int start, int textLength)
          Puts a Text Fragment event.
 void XMLPushStream.putComment(String text)
          Puts a Comment event.
 void XMLPushStream.putDocumentEnd()
          Puts a Document End event.
 boolean XMLPushStream.putDocumentStart()
          Puts a Document Start event.
 void XMLPushStream.putDTD(String name, String publicId, String systemId, String internalSubset)
          Optionally puts a DTD event.
 void XMLPushStream.putElementEnd(QName name)
          Puts an Element End event.
 void XMLPushStream.putElementStart(QName name)
          Puts an Element Start event.
 boolean XMLPushStream.putNamespace(String prefix, String namespaceURI)
          Puts a Namespace declaration event for the current element.
 void XMLPushStream.putNamespaces(Node element, int copyNamespaceMode)
          Puts Namespace declarations of the element to the stream according to the specified mode.
 void XMLPushStream.putNodeCopy(Node node, int copyNamespaceMode)
          Copies a Node to the output flow by traversing it recursively.
 void XMLPushStream.putProcessingInstruction(String target, String contents)
          Puts a Processing-instruction event.
 void XMLPushStream.putText(String text)
          Puts a Text Fragment event.
 LibraryMemberIterator Collection.queryProperties(Expression query)
          Returns an iterator over descendant Documents and Collections whose properties match a boolean XQuery expression.
 void Library.quickOptimize(int timeHint, boolean blocking)
          Performs an optimization of the underlying Library storage in limited time.
 void Library.reIndex()
          Completely rebuilds the indexes.
 Object LibraryMember.removeProperty(String propName)
          Deletes a property.
 LibraryMember Library.renameMember(String srcPath, String dstPath)
          Renames the specified member of the Library (Document or Collection).
 void LibraryMember.renameTo(String newPath)
          Renames the Document or Collection.
 void LibraryManager.saveConfiguration()
          Saves the current configuration properties of the LibraryManager onto a file attached to the Library Group (named group.conf).
 void XQueryContext.setDefaultCollation(String defaultCollation)
          Sets the URI of the default collation defined in the static context.
 void Library.setIndexing(Indexing specification)
          Defines the indexing rules used in this Library.
 void ContentImporter.setInput(InputStream input)
          Takes the data input from a byte stream.
 void ContentImporter.setInput(Reader input)
          Takes the data input from a character stream.
 void ContentImporter.setInput(String data)
          Takes the data input from a String.
 Object LibraryMember.setIntegerProperty(String propName, long propValue)
          Convenience method: defines a long integer property.
 void Indexing.Sieve.setParameters(String[] parameters)
          Defines optional parameters for the sieve.
 Object LibraryMember.setProperty(String propName, Object propValue)
          Changes the value of a property.
 void XQuerySession.setWordSieve(Indexing.WordSieve wordSieve)
          Deprecated. see XQuerySession.setFullTextFactory(com.qizx.api.fulltext.FullTextFactory)
 long NonXMLDocument.size()
          Returns the uncompressed size in bytes of the contained data.
 int Node.stringValueCompareTo(Node node, Collator collator)
          Compares the string values of two nodes, optionally using a collation.
 LibraryMemberIterator PostCommitTrigger.CommitEvent.updatedCollections()
          Returns an iterator on collections whose contents have changed in the transaction.
 LibraryMemberIterator PostCommitTrigger.CommitEvent.updatedDocuments()
          Returns an iterator on documents whose contents have changed in the transaction.
 

Uses of DataModelException in com.qizx.api.util
 

Methods in com.qizx.api.util that throw DataModelException
static Node PullStreamConverter.buildNode(XMLPullStream in)
          Directly builds an internal Node representation from a XML input stream.
static Node DOMToPushStream.convertNode(Node node)
          Utility for conversion of DOM to Data Model nodes
static int PullStreamConverter.convertTree(XMLPullStream in, XMLPushStream out)
          Reads events from the input stream until a complete well-balanced tree is sent to the output stream.
 Node PushStreamToDOM.exportNode(Node node)
          Converts a node of the XDM into a W3C DOM node.
 void XMLSerializer.flush()
          Flush of the output flow.
 void XMLSerializer.output(Node node)
          Serializes a node and its subtree.
 void XMLSerializer.putAtomText(String value)
           
 void PushStreamToSAX.putComment(String value)
           
 void PushStreamToDOM.putComment(String contents)
           
 void XMLSerializer.putComment(String contents)
           
 void DOMToPushStream.putDocument(Document document)
          Pushes a complete document to the output stream.
 void PushStreamToSAX.putDocumentEnd()
           
 void XMLSerializer.putDocumentEnd()
           
 boolean PushStreamToSAX.putDocumentStart()
           
 boolean PushStreamToDOM.putDocumentStart()
           
 boolean XMLSerializer.putDocumentStart()
           
 void DOMToPushStream.putElement(Element element)
          Pushes an element and all its descendant nodes to the output stream.
 void PushStreamToSAX.putElementEnd(QName name)
           
 void PushStreamToDOM.putElementEnd(QName name)
           
 void XMLSerializer.putElementEnd(QName name)
           
 void PushStreamToDOM.putElementStart(QName name)
           
 boolean PushStreamToSAX.putNamespace(String prefix, String namespaceURI)
           
 void XMLSerializer.putNodeCopy(Node node, int copyNsMode)
           
 void PushStreamToSAX.putProcessingInstruction(String target, String value)
           
 void PushStreamToDOM.putProcessingInstruction(String target, String contents)
           
 void XMLSerializer.putProcessingInstruction(String target, String contents)
           
 void PushStreamToSAX.putText(String value)
           
 void PushStreamToDOM.putText(String text)
           
 void XMLSerializer.putText(String value)
           
 String XMLSerializer.serializeToString(Node node)
          Serializes a node and its subtree as a string.
 void XMLSerializer.setEncoding(String encoding)
          Sets the option ENCODING.
 void XMLSerializer.setOption(String option, String value)
          Sets an option.
 void XMLSerializer.setOutput(OutputStream output)
          Defines or redefines the output.
 void XMLSerializer.setOutput(OutputStream output, String encoding)
          Defines or redefines the output.
 void XMLSerializer.setOutput(Writer output)
          Defines or redefines the output.
 

Constructors in com.qizx.api.util that throw DataModelException
PushStreamToDOM()
          Creates a DOM output using the default DOM implementation.
XMLSerializer(OutputStream output, String encoding)
          Constructs a XMLSerializer with an output stream and an encoding name.
XMLSerializer(String method)
          Constructs a XMLSerializer with specification of an output method.
 

Uses of DataModelException in com.qizx.api.util.fulltext
 

Methods in com.qizx.api.util.fulltext that throw DataModelException
 Node FullTextSnippetExtractor.makeSnippet(Node node, QName wrapperElement, QName hiliterElement, QName styleAttribute, String stylePrefix)
          Directly builds a snippet from a source Node.
 int FullTextSnippetExtractor.moveToNextEvent()
           
 int FullTextHighlighter.moveToNextEvent()
           
 void FullTextSnippetExtractor.start(Node node)
          Searches snippet components in a source XML document or node.
 void FullTextHighlighter.start(Node node)
          Starts iteration on a Node tree.
 

Constructors in com.qizx.api.util.fulltext that throw DataModelException
FullTextHighlighter(String simpleSyntaxQuery, FullTextFactory fulltextFactory, String language)
          Creates a FullTextHighlighter from a query string using the simple full-text syntax.
FullTextSnippetExtractor(String simpleSyntaxQuery, FullTextFactory fulltextFactory, String language)
          Creates a FullTextSnippetExtractor from a query string using the simple full-text syntax.
 

Uses of DataModelException in com.qizx.api.util.text
 

Methods in com.qizx.api.util.text that throw DataModelException
 void ISODateSieve.setParameters(String[] parameters)
           
 void FormatDateSieve.setParameters(String[] parameters)
           
 void FormatNumberSieve.setParameters(String[] parameters)
           
 

Uses of DataModelException in com.qizx.apps.restapi
 

Methods in com.qizx.apps.restapi that throw DataModelException
 Map<String,com.qizx.apps.util.Property> RestAPIConnection.info()
          Returns a map of system properties describing the Qizx server.
 


© 2010 Axyana Software