ATG Repository Guide
.
Documentation Home
Feedback
Highlighting
Prev
Up
Next
rql-query Tag
Child of:
named-query Tag
rql-query Child Tags
Child Tag
How many?
rql
one
Contents
Search
Introduction
Repository API
Repository Architecture
Repository Items
Item Descriptors
MutableRepository
Elements of the Repository API
atg.repository.Repository
atg.repository.RepositoryView
atg.repository.RepositoryItem
atg.repository.MutableRepository
atg.repository.PropertiesChangedEvent
Cloning Repository Items
Repository Queries
Repository Query API
atg.repository.QueryBuilder
atg.repository.QueryOptions
Repository Query Examples
Repository Queries in the ATG Control Center
Repository Query Language
RQL Overview
Comparison Queries
Text Comparison Queries
Property of Property Queries
Logical Operators
Collection Queries
Includes Item Queries
Is Null Queries
Count Expressions
All Query
Full Text Search Queries
ID-based Queries
Order By Directives
Range Directives
Parameters in Queries
Parameterized Field Queries
RQL Examples
RQL Grammar
SQL Repository Overview
Setting Up a SQL Repository
SQL Repository Architecture
Repositories and Transactions
Repository Definition Files
Default Values and XML File Combination
SQL Repository Items
SQL Repository Item Descriptors
SQL Repository Data Models
Primary and Auxiliary Tables
id Property
Single Column and Multi-Column Repository IDs
IdSpaces and the id Property
Database Sequences and Repository IDs
Auxiliary Tables
References Constraints
Properties and Database Columns
One-to-Many Relationships: Multi-Valued Properties
Operating on Multi-Valued Properties
Many-to-Many Relationships
Default Item Descriptor
Cascading Data Relationships
Cascade Insert
Cascade Update
Cascade Delete
Cascade Delete Order
Cascade Example
Item Descriptor Inheritance
Advantages of Item Descriptors Inheritance
Queries and Item Descriptor Inheritance
Item Descriptor Inheritance with the copy-from Attribute
Limitations of SQL Repository Inheritance
Derived Properties
Override Properties
Properties Derived from the Same Item
Complex Derivations
Derivation Methods
Repository Items and Session Backup
SQL Repository Item Properties
Enumerated Properties
Choosing Option Codes
Required Properties
Unique Properties
Date and Timestamp Properties
Last-Modified Properties
Null Properties
Sorting Properties
Property Validation with a Property Editor Class
Maintaining Item Concurrency with the Version Property
Repository Items as Properties
Multiple Item Properties
Adding an Item to a Multi-Item Property
Querying Subproperties
Transient Properties
Assigning FeatureDescriptorValues with the <attribute> Tag
Attributes Used in the ACC
Linking between Repositories
SQL Types and Repository Data Types
User-Defined Property Types
Identifying a User-Defined Property Type
Using the property-type Attribute
Implementing a User-Defined Property Type
Property Conversion Methods
Null Values in User-Defined Property Types
User-Defined Properties and the ACC
User-Defined Property Type Examples
Property Fetching
Handling Large Database Columns
SQL Repository Queries
Repository Filtering
Using the <rql-filter> Tag
Using the filterQuery and rqlFilterString Properties
Overriding RQL-Generated SQL
Parameterized Queries
Parameterized Query API
Query Types that Support Parameters
QueryCache and Parameterized Queries
Parameterized Query Example
Named Queries
Defining Named Queries
Defining Named Queries in the SQL Repository Definition File
Defining and Accessing Named Queries in Java Code
RQL Named Queries
SQL Named Queries
Stored Procedures
Using Stored Procedures with Oracle Databases
Named Queries and Item Inheritance
Named Query API
Text Search Queries
Simulating Text Search Queries
Wildcards in Queries
Not Queries and Null Values
Outer Joins
Table Ownership Issues
Unsupported Queries in the SQL Repository
Localizing SQL Repository Definitions
Defining a Resource Bundle
Localizing Properties
Localizing Enumerated Properties
SQL Repository Caching
Item Caches and Query Caches
Cache Invalidation
Transient Properties and Cache Invalidation
Cache Expiration
Cache Modes
Choosing a Cache Mode
Property Cache Modes
Caching Repository IDs instead of Repository Items
No Caching
Disabling Caches Globally
Simple Caching
Locked Caching
Isolation Levels
Locking Exceptions
Using Locked Cache Mode
Configuring Lock Managers
ClientLockManager
ServerLockManager
Monitoring Lock Managers
Distributed Caching via TCP
EventServer
Configuring EventServer Port Numbers
Synchronous and Asynchronous Invalidation Events
Distributed Caching via JMS
Cache Configuration
Query Cache Tuning
Item Cache Tuning
Cache Timeout
Cache Statistics
Cache Loading
Automatic Reloading
Loading with the load-items Tag
Loading with the query-items Tag
Loading with the dump-cache Tag
Cache Flushing
Cache Invalidation Service
Enabling the Cache Invalidator
Configuring the SQL-JMS System for Cache Invalidation
Invoking the Cache Invalidator Manually
Using the Cache Invalidator with Distributed Caching
Caching and Item Descriptor Inheritance
Development, Testing and Debugging with the SQL Repository
Adding Items
Adding Items with Composite IDs
Adding Items without Specifying IDs
Adding Items to Multi-Item Properties
Updating Items
Removing Items
Removing References to Items
Querying Items
Importing and Exporting Items and DDLs
startSQLRepository Script and the Template Parser
Using the startSQLRepository Script
startSQLRepository Script Arguments
SQL Repository Test Example
Exporting Repository Data
Using Operation Tags in the Repository Administration Interface
Debug Levels
Modifying a Repository Definition
SQL Repository Reference
SQL Repository Definition Tag Reference
DOCTYPE Tag (SQL Repository)
gsa-template Tag
header Tag (SQL Repository)
item-descriptor Tag (SQL Repository)
table Tag
property Tag (SQL Repository)
Data Type Correspondences
option Tag (SQL Repository)
attribute Tag (SQL Repository)
derivation Tag
expression Tag
rql-filter Tag
Named Query Tags
named-query Tag
rql-query Tag
rql Tag
sql-query Tag
sql Tag
input-parameter-types Tag
returns Tag
dependencies Tag
Development Operation Tags
transaction Tag
rollback-transaction Tag
import-items Tag
add-item Tag
update-item Tag
query-items Tag
print-item Tag
set-property Tag
remove-item Tag
remove-all-items Tag
export-items Tag
load-items Tag
dump-caches Tag
print-ddl Tag
Document Type Definition for SQL Repository Definition Files
Sample SQL Repository Definition Files
Repository Example A: Simple One-to-One
Repository Example B: One-to-One with Auxiliary Table
Repository Example C: One-to-Many with an Array
Repository Example D: One-to-Many with a Set
Repository Example E: One-to-Many with a Map
Repository Example F: One-to-Many Mapping to Other Repository Items
Repository Example G: Ordered One-to-Many
Repository Example H: Many-to-Many
Repository Example I: Multi-Column Repository IDs
Configuring the SQL Repository Component
Registering a Content Repository
SQL Repository Component Properties
SQL Content Repositories
Setting Up a SQL Content Repository
Creating a SQL Content Repository Definition
Folder and Content Item Descriptors
Path and Item ID Attributes
Defining Content Item Descriptors
Content Attributes and Properties
Storing Content on a File System
Content Repository Example
Book Item Type Properties
Locating the Content with Path and Folder Properties
Book Example Repository Definition File
Book Example SQL Table Creation Statements
Adding Content to the Content Repository
Accessing Items in the Content Repository
Configuring a SQL Content Repository
Repository Loader
Repository Loader Architecture
FileSystemMonitorService
FileSystemMonitorScheduler
LoaderManager
TypeMapper and TypeMappings
Content Handlers and Back Ends
User Interface Elements
Using the Repository Loader
Repository Loader Form Handlers and Administration Pages
Error Policies
Repository Loader RMI Client
RLClient Hints
Using a Repository Loader Manifest
Repository Loader Manifest File Document Type Definition
Repository Loader Manifest File Tags
Configuring the Repository Loader Components
Setting Up the FileSystemMonitorService
Configuring the LoaderManager
Configuring the FileSystemMonitorScheduler
Configuring the TypeMapper
Configuring a TypeMapping
Setting Up the Xml2RepositoryContentHandler
Choosing your Configuration
Repository Loader Example
User Example Item Type
Example Item Pathnames
Type Mappings and Content Handlers
Example TypeMapper
xml2repository Schemas
Running the RL Example
Repository Web Services
GetRepositoryItem Web Service
PerformRQLQuery Web Service
PerformRQLCountQuery Web Service
Repository Web Service Security
Composite Repositories
Use Example
Primary and Contributing Item Descriptors
Item Inheritance and Composite Repositories
Transient Properties and Composite Repositories
Non-Serializable Items and Composite Repositories
Property Derivation
Configuring a Composite Repository
Property Mappings
Excluding Properties
Link Methods
Creating Composite and Contributing Items
Missing Contributing Items
Configuring the Composite Repository Component
Composite Repository Queries
Composite Repository Caching
Composite Repository Definition File Tag Reference
composite-repository-template Tag
header Tag (Composite Repository)
item-descriptor Tag (Composite Repository)
primary-item-descriptor Tag
contributing-item-descriptor Tag
attribute Tag (Composite Repository)
property Tag (Composite Repository)
primary-item-descriptor-link Tag
link-via-id Tag
link-via-property Tag
Composite Repository Document Type Definition
Sample Composite Repository Definition File
Secured Repositories
Secured Repository Features
Access Rights
Creating a Secured Repository
Modifying the Underlying Repository
Configuring the Secured Repository Adapter Component
Register the Secured Repository Adapter
Writing the Secured Repository Definition File
Group Membership
ACLs and Personae
ACL Syntax
Standard Access Rights
ACL Examples
Secured Repository Definition File Tag Reference
secured-repository-template Tag
item-descriptor Tag (Secured Repository)
property Tag (Secured Repository)
default-acl Tag
descriptor-acl Tag
owner-property Tag
acl-property Tag
creation-base-acl Tag
creation-owner-acl-template Tag
creation-group-acl-template Tag
Secured Repository Definition File Document Type Definition
Secured Repository Example
Performance Considerations
Exceptions Thrown by the Secured Repository
LDAP Repositories
Overview: Setting Up an LDAP Repository
LDAP Directory Primer
Hierarchical Tree Structure
LDAP Data Representation
Hierarchical Entry Types
Directory Schema
LDAP and JNDI
LDAP Sources
LDAP Repository Architecture
LDAP Repository Items and Repository IDs
Item Descriptors and LDAP Object Classes
Item Descriptor Hierarchies and Inheritance
Id and ObjectClasses Properties
Additional Property Tag Attributes
New Item Creation
Repository Views in the LDAP Repository
Repository View Definition
LDAP Repository View Example
LDAP Repository Queries
ID Matching Queries
Unsupported Queries in the LDAP Repository
Configuring the LDAP Repository Components
/atg/adapter/ldap/LDAPRepository
/atg/adapter/ldap/InitialContextPool
/atg/adapter/ldap/InitialContextEnvironment
/atg/adapter/ldap/LDAPItemCache
/atg/adapter/ldap/LDAPItemCacheAdapter
/atg/adapter/ldap/LDAPQueryCache
/atg/adapter/ldap/LDAPQueryCacheAdapter
LDAP Password Encryption
LDAP Repository Definition Tag Reference
DOCTYPE Tag (LDAP Repository)
ldap-adapter-template Tag
header Tag (LDAP Repository)
view Tag
item-descriptor Tag (LDAP Repository)
id-property Tag
object-classes-property Tag
object-class Tag
property Tag (LDAP Repository)
option Tag (LDAP Repository)
attribute Tag (LDAP Repository)
child-property Tag
new-items Tag
search-root Tag
Sample LDAP Repository Definition File
Document Type Definition for LDAP Repository Definition Files
Index
