User Guide

The User guide details installation, usage of Jofti, the syntax for the query language, and the behaviour of the index with regard to Data Types and Transactions.

 

  1. 1. Getting Started
    1. 1.1  Introduction
    2. 1.2  Terms
    3. 1.3  Types of Applications
    4. 1.4  Installing Jofti
  2. 2. Configuration
    1. 2.1  Built in Classes
    2. 2.2  Configuring Jofti as a Cache listener.
    3. 2.3  Adding Classes to an Index without pre-configuration
    4. 2.4  Configuring Jofti as a wrapper for a Cache.
    5. 2.5  Configuring Name-spaced Caches.
    6. 2.6  Indexing already populated Caches
    7. 2.7  Configuring Disk overflow
  3. 3. Querying
    1. 3.0  Query Types
    2. 3.1.0  EJB3 QL Format Queries
    3. 3.1.1  Basic EJB3 QL Queries
    4. 3.1.2  Nested Clauses In EJB3 QL Queries
    5. 3.1.3  Nested Objects in EJB3 QL Queries
    6. 3.1.4  Using Multiple Classes in EJB3 QL Queries
    7. 3.1.5  Name Spaced Caches and EJB3 QL Queries
    8. 3.1.6  Using LIKE in EJB3 QL Queries
    9. 3.1.7  Escape Sequences in EJB3 QL Queries
    10. 3.1.8  Named Parameters EJB3 QL Queries
    11. 3.1.9  Positional Parameters EJB3 QL Queries
    12. 3.1.10  Return types from EJB3 QL Queries
    13. 3.1.11  Retrieving Object attributes in EJB3 QL Queries
    14. 3.1.12  Specifying named queries in the config file
    15. 3.1.13  Sorting of EJB3QL Query Results
    16. 3.1.14  Max result limits in EJB3 queries
    17. 3.1.15  Paging results in EJB3 queries

    18. 3.2.0  SQL Format Queries
    19. 3.2.1  Basic SQL Queries
    20. 3.2.2  Nested Clauses In SQL Queries
    21. 3.2.3  Nested Objects in SQL Queries
    22. 3.2.4  Using Multiple Classes in SQL Queries
    23. 3.2.5  Name Spaced Caches and SQL Queries
    24. 3.2.6  Using LIKE in SQL Queries
    25. 3.2.7  Escape Sequences in SQL Queries
    26. 3.2.8  Sorting of SQL Query Results
  4. 4. Querying & Data Types in Jofti
    1. 4.1  Primitives
    2. 4.2  Booleans
    3. 4.3  Excluded Comparable Objects
    4. 4.4  Dates
    5. 4.5  Timestamp
    6. 4.6  Interfaces and Concrete Class Inheritence
    7. 4.7  Dynamic Proxies
    8. 4.8  Inner Classes
    9. 4.9  NULL
    10. 4.10  Top Level Typed Arrays
    11. 4.11  Top Level Object Arrays
    12. 4.12  Arrays as attributes of Objects
    13. 4.13  Top level Collections, Lists and Sets
    14. 4.14  Collections, Lists and Sets as attributes of Objects
    15. 4.15  User Defined Types
  5. 5. Disk Overflow
    1. 5.1  Types
    2. 5.2  Performance Profile
  6. 6. Index Management
    1. 6.1  Lifecycle events
    2. 6.2  Mutable Objects in Jofti
    3. 6.3  Dependency Injection
  7. 7. Transaction Support
    1. 7.1  JBossCache Support
    2. 7.2  NONE and READ_UNCOMMITTED
    3. 7.3  READ_COMMITTED
    4. 7.4  REPEATABLE_READ
    5. 7.5  SERIALIZABLE
    6. 7.6  Tangosol Coherence support
  8. 8. Version API Changes
    1. 8.1.0  Changes from 1.1 to 1.2
    2. 8.1.1  Index Interfaces
    3. 8.1.2  Query Classes

    4. 8.2.0  Changes from 1.0 to 1.1
    5. 8.2.1  Index Interfaces
    6. 8.2.2  Obtaining an Index

Preview release

1.2-rc4 now available:

  • Support for IBM ObjectGrid
  • Support for Tangosol Coherence v3
  • Support for EHCache 1.2.3
  • Multi-attribute sorting
  • Max result limits
  • Paging of results
  • Disk overflow for large indexes
  • Addition of EJB3 QL format queries
  • Support for named parameters in queries
  • Support for positional parameters in Queries
  • Specification of object fields to return
  • Improved perfomance and memory usage and much, much more...

Download preview

Features

  • Multi Cache support
  • Transaction support
  • Type aware searching
  • Configurable property indexing
  • Indexing/searching by interfaces
  • Support for dynamic proxies
  • Support for primitve attributes
  • Support for collections and arrays
  • String prefix searching
  • Simple query language