|
Copyright © 2000, 2008, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IMetadataQuery
Interface to metadata query. Metadata include system properties(cm_path, cm_nodeName,..etc), and non-binary user properties defined in CM content.
To get an instance of this class, use:
IMetadataQuery mQuery = FullTextQueryFactory.getMetadataQuery();
Use the constants in this class as such:
IMetadataQuery.SystemProperty.cm_nodeIdSee javadocs on the ISearchManager interface for a more complete example.
Nested Class Summary | |
---|---|
static class |
IMetadataQuery.Multiplicity
Multiplicity is used when searching user properties, and is used to restrict the search results to user (objectclass) properties with the specified name and multiplicity. |
static class |
IMetadataQuery.SystemProperty
These are system properties available for full text searching |
Method Summary | |
---|---|
IMetadataQueryParameter |
buildAfter(IMetadataQuery.SystemProperty sysProp,
Calendar criteria)
Matches a system property which contains a date that is later than or equal to the specified date |
IMetadataQueryParameter |
buildAfter(String userPropertyField,
Calendar criteria)
Matches a user property which contains a date that is later than or equal to the specified date |
IMetadataQueryParameter |
buildBefore(IMetadataQuery.SystemProperty sysProp,
Calendar criteria)
Matches a system property which contains a date that is earlier than or equal to the specified date |
IMetadataQueryParameter |
buildBefore(String userPropertyField,
Calendar criteria)
Matches a user property which contains a date that is earlier than or equal to the specified date |
IMetadataQueryParameter |
buildContains(IMetadataQuery.SystemProperty sysProp,
String[] values)
Matches a system property any criteria from a given list of criteria |
IMetadataQueryParameter |
buildContains(String userPropertyField,
String[] values)
Matches a user property any criteria from a given list of criteria |
IMetadataQueryParameter |
buildContainsAll(IMetadataQuery.SystemProperty sysProp,
String[] values)
Matches all criteria from a given list of one or more criteria |
IMetadataQueryParameter |
buildContainsAll(String userPropertyField,
String[] values)
Matches all criteria from a given list of one or more criteria |
IMetadataQueryParameter |
buildEquals(IMetadataQuery.SystemProperty sysProp,
String criteria)
Matches the exact string value of the criteria. |
IMetadataQueryParameter |
buildEquals(IMetadataQuery.SystemProperty sysProp,
String[] criteria)
Matches one or more exact string values from the given list. |
IMetadataQueryParameter |
buildEquals(String userPropertyField,
String criteria)
Matches the exact string value of the criteria. |
IMetadataQueryParameter |
buildEquals(String userPropertyField,
String[] criteria)
Matches one or more exact string values from the given list. |
IMetadataQueryParameter |
buildGreaterThan(IMetadataQuery.SystemProperty sysProp,
Number criteria)
Matches a system property which is greater than a numeric value |
IMetadataQueryParameter |
buildGreaterThan(String userPropertyField,
Number criteria)
Matches a user property which is greater than a numeric value |
IMetadataQueryParameter |
buildIsNull(IMetadataQuery.SystemProperty sysProp)
Matches a system property which does not have a value set |
IMetadataQueryParameter |
buildIsNull(String userPropertyField)
Matches a user property which does not have a value set |
IMetadataQueryParameter |
buildLessThan(IMetadataQuery.SystemProperty sysProp,
Number criteria)
Match a system property that is less then the specified criteria, for example size less than 1000 |
IMetadataQueryParameter |
buildLessThan(String userPropertyField,
Number criteria)
Match a user property that is less then the specified criteria, for example size less than 1000 |
IMetadataQueryParameter |
buildLike(IMetadataQuery.SystemProperty sysProp,
String criteria)
Corresponds to an SQL "like" (case sensitive) |
IMetadataQueryParameter |
buildLike(String userPropertyField,
String criteria)
Corresponds to an SQL "like" (case sensitive) |
IMetadataQueryParameter |
buildLikeIgnoreCase(IMetadataQuery.SystemProperty sysProp,
String criteria)
Corresponds to an SQL "like" (without case sensitivity) |
IMetadataQueryParameter |
buildLikeIgnoreCase(String userPropertyField,
String criteria)
Corresponds to an SQL "like" (without case sensitivity) |
IMetadataQueryParameter |
buildNotEquals(IMetadataQuery.SystemProperty sysProp,
String criteria)
Matches when the specified criteria does not exist |
IMetadataQueryParameter |
buildNotEquals(IMetadataQuery.SystemProperty sysProp,
String[] criteria)
Matches a system property whem none of specified criteria exists in the system property |
IMetadataQueryParameter |
buildNotEquals(String userPropertyField,
String criteria)
Matches when the specified criteria does not exist in the user property |
IMetadataQueryParameter |
buildNotEquals(String userPropertyField,
String[] criteria)
Matches a user property whem none of specified criteria exists in the user property |
IMetadataQueryParameter |
buildNotNull(IMetadataQuery.SystemProperty sysProp)
Matches a system property which is set(with some unspecified value). |
IMetadataQueryParameter |
buildNotNull(String userPropertyField)
Matches a user property which is set(with some unspecified value). |
IMetadataQueryParameter |
buildRange(IMetadataQuery.SystemProperty sysProp,
Calendar begin,
Calendar end)
Matches a user property which contains a date that falls within the inclusive range of two dates. |
IMetadataQueryParameter |
buildRange(String userPropertyField,
Calendar begin,
Calendar end)
Matches a user property which contains a date that falls within the inclusive range of two dates. |
IMetadataQueryParameter |
buildSimilarTo(IMetadataQuery.SystemProperty sysProp,
String criteria)
Used for "similar", possibly misspelled text |
IMetadataQueryParameter |
buildSimilarTo(String userPropertyField,
String criteria)
Used for "similar", possibly misspelled text |
IMetadataQueryParameter |
buildWildcard(IMetadataQuery.SystemProperty sysProp,
String criteria)
Used for matching criteria containing the wildcards '*' or '?' |
IMetadataQueryParameter |
buildWildcard(String userPropertyField,
String criteria)
Used for matching criteria containing the wildcards '*' or '?' |
Method Detail |
---|
IMetadataQueryParameter buildLessThan(String userPropertyField, Number criteria) throws InvalidQueryException
userPropertyField
- The name of the user propertycriteria
- The numeric criteria that the user property is less than.
InvalidQueryException
- If the criteria given builds an invalid query.IMetadataQueryParameter buildLessThan(IMetadataQuery.SystemProperty sysProp, Number criteria) throws InvalidQueryException
sysProp
- The system propertycriteria
- The numeric criteria that the system property is less than.
InvalidQueryException
- If the criteria given builds an invalid query.IMetadataQueryParameter buildGreaterThan(String userPropertyField, Number criteria) throws InvalidQueryException
userPropertyField
- The name of the user propertycriteria
- The numeric value
InvalidQueryException
- If the criteria given builds an invalid query.IMetadataQueryParameter buildGreaterThan(IMetadataQuery.SystemProperty sysProp, Number criteria) throws InvalidQueryException
sysProp
- The system propetycriteria
- The numeric value
InvalidQueryException
- If the criteria given builds an invalid query.IMetadataQueryParameter buildBefore(String userPropertyField, Calendar criteria) throws InvalidQueryException
userPropertyField
- The name of the user propertycriteria
- The specified date
InvalidQueryException
- If the criteria given builds an invalid query.IMetadataQueryParameter buildBefore(IMetadataQuery.SystemProperty sysProp, Calendar criteria) throws InvalidQueryException
sysProp
- The system propertycriteria
- The specified date
InvalidQueryException
- If the criteria given builds an invalid query.IMetadataQueryParameter buildAfter(String userPropertyField, Calendar criteria) throws InvalidQueryException
userPropertyField
- The name of the user propertycriteria
- The specified date
InvalidQueryException
- If the criteria given builds an invalid query.IMetadataQueryParameter buildAfter(IMetadataQuery.SystemProperty sysProp, Calendar criteria) throws InvalidQueryException
sysProp
- The system propertycriteria
- The specified date
InvalidQueryException
- If the criteria given builds an invalid query.IMetadataQueryParameter buildRange(String userPropertyField, Calendar begin, Calendar end) throws InvalidQueryException
userPropertyField
- The name of the user propertybegin
- The begining of the time period. If it is null, the period ranges up to the end date, including any date before the end date).end
- The ending of the time period. If it is null, the period ranges from the begin date, including any date after the begin date.
InvalidQueryException
- If the criteria given builds an invalid query.IMetadataQueryParameter buildRange(IMetadataQuery.SystemProperty sysProp, Calendar begin, Calendar end) throws InvalidQueryException
sysProp
- The system propertybegin
- The begining of the time period. If it is null, the period ranges up to the end date, including any date before the end date.end
- The ending of the time period. If it is null, the period ranges from the begin date, including any date after the begin date.
InvalidQueryException
- If the criteria given builds an invalid query.IMetadataQueryParameter buildIsNull(String userPropertyField) throws InvalidQueryException
userPropertyField
- The name of the user property
InvalidQueryException
- If the criteria given builds an invalid query.IMetadataQueryParameter buildIsNull(IMetadataQuery.SystemProperty sysProp) throws InvalidQueryException
sysProp
- The name of the system property
InvalidQueryException
- If the criteria given builds an invalid query.IMetadataQueryParameter buildNotNull(String userPropertyField) throws InvalidQueryException
userPropertyField
- The name of the user property
InvalidQueryException
- If the criteria given builds an invalid query.IMetadataQueryParameter buildNotNull(IMetadataQuery.SystemProperty sysProp) throws InvalidQueryException
sysProp
- The name of the system property
InvalidQueryException
- If the criteria given builds an invalid query.IMetadataQueryParameter buildContains(String userPropertyField, String[] values) throws InvalidQueryException
userPropertyField
- The name of the user propertyvalues
- The list of criteria
InvalidQueryException
- If the criteria given builds an invalid query.IMetadataQueryParameter buildContains(IMetadataQuery.SystemProperty sysProp, String[] values) throws InvalidQueryException
sysProp
- The system propertyvalues
- The list of criteria
InvalidQueryException
- If the criteria given builds an invalid query.IMetadataQueryParameter buildContainsAll(String userPropertyField, String[] values) throws InvalidQueryException
userPropertyField
- The name of the user propertyvalues
- The list of criteira
InvalidQueryException
- If the criteria given builds an invalid query.IMetadataQueryParameter buildContainsAll(IMetadataQuery.SystemProperty sysProp, String[] values) throws InvalidQueryException
sysProp
- The name of the system propertyvalues
- The list of criteria
InvalidQueryException
- If the criteria given builds an invalid query.IMetadataQueryParameter buildEquals(String userPropertyField, String criteria) throws InvalidQueryException
userPropertyField
- The name of the user propertycriteria
- The string value
InvalidQueryException
- If the criteria given builds an invalid query.IMetadataQueryParameter buildEquals(IMetadataQuery.SystemProperty sysProp, String criteria) throws InvalidQueryException
sysProp
- The system propertycriteria
- The string value
InvalidQueryException
- If the criteria given builds an invalid query.IMetadataQueryParameter buildEquals(String userPropertyField, String[] criteria) throws InvalidQueryException
userPropertyField
- The name of the user propertycriteria
- The list of string values
InvalidQueryException
- If the criteria given builds an invalid query.IMetadataQueryParameter buildEquals(IMetadataQuery.SystemProperty sysProp, String[] criteria) throws InvalidQueryException
sysProp
- The system propertycriteria
- The list of string values
InvalidQueryException
- If the criteria given builds an invalid query.IMetadataQueryParameter buildNotEquals(String userPropertyField, String criteria) throws InvalidQueryException
userPropertyField
- The name of the user propertycriteria
- The criteria which does not exist in the property
InvalidQueryException
- If the criteria given builds an invalid query.IMetadataQueryParameter buildNotEquals(IMetadataQuery.SystemProperty sysProp, String criteria) throws InvalidQueryException
sysProp
- The system propertycriteria
- The criteria which does not exist in the property
InvalidQueryException
- If the criteria given builds an invalid query.IMetadataQueryParameter buildNotEquals(String userPropertyField, String[] criteria) throws InvalidQueryException
userPropertyField
- The name of the user propertycriteria
- The list of criteria which do not exist in the property
InvalidQueryException
- If the criteria given builds an invalid query.IMetadataQueryParameter buildNotEquals(IMetadataQuery.SystemProperty sysProp, String[] criteria) throws InvalidQueryException
sysProp
- The system propertycriteria
- The list of criteria which do not exist in the property
InvalidQueryException
- If the criteria given builds an invalid query.IMetadataQueryParameter buildWildcard(String userPropertyField, String criteria) throws InvalidQueryException
userPropertyField
- The name of the user propertycriteria
- The criteria containing the wildcards
InvalidQueryException
- If the criteria given builds an invalid query.IMetadataQueryParameter buildWildcard(IMetadataQuery.SystemProperty sysProp, String criteria) throws InvalidQueryException
sysProp
- The system propertycriteria
- The criteria containing the wildcards
InvalidQueryException
- If the criteria given builds an invalid query.IMetadataQueryParameter buildLike(String userPropertyField, String criteria) throws InvalidQueryException
userPropertyField
- The name of the user propertycriteria
- The criteria
InvalidQueryException
- If the criteria given builds an invalid query.IMetadataQueryParameter buildLike(IMetadataQuery.SystemProperty sysProp, String criteria) throws InvalidQueryException
sysProp
- The name of the system propertycriteria
- The criteria
InvalidQueryException
- If the criteria given builds an invalid query.IMetadataQueryParameter buildLikeIgnoreCase(String userPropertyField, String criteria) throws InvalidQueryException
userPropertyField
- The name of the user propertycriteria
- The criteria
InvalidQueryException
- If the criteria given builds an invalid query.IMetadataQueryParameter buildLikeIgnoreCase(IMetadataQuery.SystemProperty sysProp, String criteria) throws InvalidQueryException
sysProp
- The system propertycriteria
- The criteria
InvalidQueryException
- If the criteria given builds an invalid query.IMetadataQueryParameter buildSimilarTo(String userPropertyField, String criteria) throws InvalidQueryException
userPropertyField
- The name of the user propertycriteria
- The criteria to check.
InvalidQueryException
- If the criteria given builds an invalid query.IMetadataQueryParameter buildSimilarTo(IMetadataQuery.SystemProperty sysProp, String criteria) throws InvalidQueryException
sysProp
- The system propertycriteria
- The criteria to check.
InvalidQueryException
- If the criteria given builds an invalid query.
|
Copyright © 2000, 2008, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |