Qizx Manual

Axyana Software

Version 4.4

December 2011


Table of Contents

Foreword
I. Installation
1. Requirements
2. Installation
1. Install on Linux
2. Manual install on Windows
3. Installation of Qizx Server
3. Content of the distribution
II. User's Guide
4. Getting started
1. Introduction
1.1. About the data samples used in this tutorial
2. Creating an XML Library
2.1. Creating a Library using Qizx Studio
2.2. Creating a Library using the qizx command-line tool
3. Populating a Library with Collections and Documents
3.1. Importing XML Documents using Qizx Studio
3.2. Importing XML Documents using the qizx tool
4. Exporting Documents from an XML Library
4.1. Using Qizx Studio
4.2. Using the qizx command-line tool
5. Querying a Library
5.1. Writing and running queries with Qizx Studio
5.2. Running queries with the qizx command line tool
6. Copying, Renaming, Deleting Documents and Collections
6.1. Using Qizx Studio
6.2. Using the qizx command-line tool
7. Updating XML Documents
8. Using Metadata Properties
8.1. Properties in Qizx Studio
8.2. Properties in the qizx command-line tool
8.3. Extension functions for Property handling
8.4. Using property queries to restrict the search domain of a standard query
8.5. Custom indexes
5. Installing and Using Qizx Server
1. Architecture
1.1. Protocol
1.2. Server-side Implementation
1.3. Client-side Implementation
2. Installation
2.1. Requirements
2.2. Deployment of the standalone server with a configuration wizard
2.3. Manual Installation Procedure
2.3.1. Troubleshooting
2.4. Testing the server
2.5. What to do next
3. Access Control
3.1. How ACL work in Qizx Server
3.2. Setting ACL in Qizx Server
4. Developer Documentation
4.1. API service
4.2. XQuery services
4.2.1. Protocol
4.2.2. Creating services
4.2.3. Description of available services
4.2.4. Parameters
4.2.5. Result type and output options
4.2.6. Documentation of services
4.3. XQuery webApps
4.3.1. Creating an XQuery webApp
4.3.2. Parameters
4.3.3. Result content-type and output options
4.3.4. Function API
4.3.5. Modules and resources
6. Support of standard XQuery Update
7. Support of standard XQuery Full-Text
1. Tutorial Introduction to the standard XQuery Full-Text
2. Support of the XQuery Full-Text facilities in Qizx
2.1. Supported Features
2.2. Unsupported Features
2.3. Scoring
2.4. Tokenization
2.5. Other pluggable functionalities
3. Migration Guide from former Full-Text implementation
8. Support of EXPath Packages
1. Installing EXPath Packages
1.1. Installation in Qizx Server
2. Using Packages in Qizx
9. Configuring the indexing process
1. Introduction
2. Indexing in Qizx
2.1. Indexes
2.2. Indexing Specifications
2.2.1. General structure of an Indexing Specification
2.2.2. Global properties
2.2.3. Conversion rules
2.2.4. Rules for the conversion of simple element contents
2.2.5. Rules for the conversion of attribute values
2.3. Default Indexing Specification
3. Configuring Indexing
3.1. Writing a new Indexing Specification
3.2. Changing the Indexing Specification of a Library
3.3. Writing custom Sieves
III. Developer's Guide
10. Programming with the Qizx API
1. What you'll learn
1.1. About the data samples used in this tutorial
1.2. Compiling and running the code samples
2. Creating a Library and populating it with Collections and Documents
2.1. Creating a LibraryManager
2.2. Creating a Library
2.3. Creating Collections and importing Documents
2.4. The dual nature of the Library object: both a database and a transactional session
2.5. Compiling and running the code of this lesson
3. Retrieving Documents stored in a database
3.1. Compiling and running the code of this lesson
4. Querying a database
4.1. Compiling and running the code of this lesson
5. Deleting Documents and Collections
5.1. Compiling and running the code of this lesson
6. Modifying a Document stored in a database
6.1. Updating a Document using XQuery Update
6.1.1. Compiling and running the code of this lesson
6.2. Updating a Document using the Java API and DOM
6.2.1. Compiling and running the code of this lesson
7. Customizing the indexing of XML content
7.1. Re-indexing a Library
7.2. Writing a custom Indexing.NumberSieve
7.3. Compiling and running the code of this lesson
8. Adding metadata to Documents
8.1. Compiling and running the code of this lesson
9. Convenience and utility classes provided by the API
9.1. Package com.qizx.api.util
9.2. Package com.qizx.api.util.fulltext
9.3. Package com.qizx.api.util.accesscontrol
11. Writing efficient queries
1. The problem
1.1. An example
2. Performance Guidelines
2.1. Text search
2.2. Path Expressions
2.2.1. Indexable features of Path expressions
2.2.2. Inefficient functions or expressions
2.3. Planned enhancements
IV. Reference
12. General XQuery extension functions
1. Serialization
1.1. Serialization to XML, HTML, XHTML, plain text
1.2. JSON Serialization
2. Parsing
2.1. XML Parsing
2.2. Semi-structured Content Parsing
2.2.1. JSON parser
2.2.2. HTML parser
2.2.3. HTML5 parser
3. XSL Transformation
4. Dynamic evaluation
5. Query extensions
5.1. Estimated count and pagination
5.2. Pattern-matching
5.3. Range testing
6. Date and Time
6.1. Differences with W3C specifications
6.2. Cast Extensions
6.3. Additional constructors
6.4. Additional accessors
7. Error handling
13. Full-text XQuery extension functions
1. Simplified full-text search
1.1. Definition of the simple full-text syntax
1.2. Search function
2. Other full-text extension functions
3. Examples
14. XML Library extension functions
1. Predefined properties
15. Administration extension functions
1. Server Functions reference
2. Admin Functions reference
16. WebApp extension functions
1. Request
2. Response
3. Session
17. Java™ Binding
V. Tools
qizx — Qizx command line tool
Qizx Studio Help
1. Starting Qizx Studio
2. The 'XML Libraries' tab
2.1. Library browser
2.2. Metadata Properties view
2.3. Document display
2.3.1. Export document to file
2.3.2. View mode
3. The 'XQuery' tab
3.1. XQuery Editor
3.1.1. Query Execution
3.1.2. Stopping Query execution
3.1.3. Clear editor text
3.2. Result View
3.2.1. Move forward and backward in result sequence
3.2.2. Export result sequence to a file
3.2.3. Change the display style of results
3.3. Message View
4. The 'Admin' Tab
4.1. Configuration tab
4.2. Maintenance Tasks tab
4.2.1. Running tasks
4.2.2. Past tasks
4.2.3. Manual Operations
4.2.4. Scheduled Full Backup
4.2.5. Scheduled Incremental Backup
4.2.6. Scheduled Optimize
4.3. Statistics tab
4.4. Running Queries tab
5. Dialogs
5.1. Open local Library Group dialog
5.2. Connect to Server dialog
5.3. 'XML Catalogs' dialog
5.4. 'Create Collection' dialog
5.5. 'Import Documents' dialog
5.6. 'Import non-XML Documents' dialog
5.7. 'Export Document' dialog
5.8. Metadata Property Editor dialog
5.9. 'Change Indexing Specification' dialog
5.9.1. Reindexing Dialog
5.9.2. Optimize Library Dialog
5.10. 'Backup Library' dialog
5.11. 'Error Log' dialog
Glossary

List of Figures

4.1. Qizx Studio first launch
4.2. Creating an XML Library
4.3. Library browser after importing documents
4.4. Exporting a Document from an XML Library
4.5. Result of a query
4.6. Adding a new property 'meta-info-1'
5.1. Qizx Server Architecture
5.2. API demonstration and test pages
1. XML Libraries tab
2. XQuery tab
3. XQuery tab with miscellaneous results
4. Export results dialog
5. Connect to Server dialog
6. Connect to Server authentication dialog
7. Import dialog
8. Import dialog
9. Backup dialog

List of Tables

5.1. Permissions
7.1. Correspondence from former full-text
12.1. Implemented serialization options
12.2. Implemented JSON serialization options
12.3. XSLT transform options
17.1. Types conversions

List of Examples

4.1. Delete a Node
4.2. insert the Spanish edition of "Planet of the Apes".