|
Qizx fe-4.4p2 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Collection
Collections can contain XML Documents and sub-Collections.
They are similar to folders in a disk file-system, and thus can be used to organize documents in hierarchies. It is possible to restrict XQuery queries to the documents contained within a particular Collection or set of Collections.
As a LibraryMember
, a Collection can hold Metadata Properties.
A Collection can be used as the root of a XQuery Path Expression,
either explicitly through the XQuery function fn:collection or the extension
function xlib:collection, or implicitly in an Expression
through the
method Expression.bindImplicitCollection(LibraryMember)
.
LibraryMember
Field Summary |
---|
Fields inherited from interface com.qizx.api.LibraryMember |
---|
COLLECTION, DOCUMENT, NATURE, NONXMLDOC, PATH |
Method Summary | |
---|---|
Collection |
createChildCollection(String name)
Creates a Collection direct child of this collection. |
LibraryMember |
getChild(String name)
Returns the direct child of this collection (Document or Collection) that bears this name. |
LibraryMemberIterator |
getChildren()
Returns an iterator over members (Documents and Collections) directly contained in this Collection. |
LibraryMemberIterator |
getChildren(LibraryMemberFilter filter)
Returns an iterator over members directly contained in this Collection and accepted by the specified filter. |
LibraryMemberIterator |
queryProperties(Expression query)
Returns an iterator over descendant Documents and Collections whose properties match a boolean XQuery expression. |
Methods inherited from interface com.qizx.api.LibraryMember |
---|
contains, copyTo, delete, exists, getIntegerProperty, getLibrary, getName, getParent, getParentPath, getPath, getProperty, getPropertyNames, hasProperty, isCollection, isDocument, lock, removeProperty, renameTo, setIntegerProperty, setProperty |
Method Detail |
---|
LibraryMember getChild(String name) throws DataModelException
name
- a simple name without slash.
DataModelException
- common causesLibraryMemberIterator getChildren() throws DataModelException
DataModelException
- common causesLibraryMemberIterator getChildren(LibraryMemberFilter filter) throws DataModelException
filter
- a LibraryMemberFilter implementation that accepts or
rejects a member
DataModelException
- common causesLibraryMemberIterator queryProperties(Expression query) throws EvaluationException, DataModelException
Example:
Expression exp = library.compileExpression("type='document' and import-date gt xs:date('2006-12-31') and dm.totalSize > 10000"); LibraryMemberIterator result = collection.queryProperties(exp);This metadata query would return all documents (property type) whose import-date property is greater than the value given and whose document size (property dm.totalSize) is greater than 10000 (bytes).
Metadata Property Query: the particular form of expression suitable for queryProperties is called a metadata query. It can be any boolean expression that could be used as a predicate in a Path expression (between square brackets).
ft:contains('completed', taskinfo/status)
.
query
- a metadata query about the properties of
contained Documents or Collections.
EvaluationException
- on run-time error in the query expression
DataModelException
- common causesCollection createChildCollection(String name) throws DataModelException
name
- a simple name without slash.
DataModelException
- common causes
|
© 2010 Axyana Software | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |