|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ITextQuery
This interface is used to query the free text within the binary content. Binary content exists in the binary property in a CM node.
To get an instance of this class, use:
ITextQuery tQuery = FullTextQueryFactory.getTextQuery();See javadocs on the ISearchManager interface for a more complete example.
Note: there are no specific build methods for wildcard queries, as they end up being built the same as an equals query.
tQuery.buildEquals("*")
will retrieve every node that was indexed.
tQuery.buildEquals("Search")
and tQuery.buildEquals("*Search*")
will return the same
results, though tQuery.buildEquals("Sea")
and tQuery.buildEquals("Sea*")
will not.
Method Summary | |
---|---|
ITextQueryParameter |
buildContains(String criteria)
Match if the value is contained in indexed content |
ITextQueryParameter |
buildContainsAll(String[] criteria)
Match if all of the values are contained in the index content. |
ITextQueryParameter |
buildContainsAny(String[] criteria)
Match if any of the values are contained in indexed content |
ITextQueryParameter |
buildEquals(String criteria)
match the exact value |
ITextQueryParameter |
buildEquals(String[] criteria)
Deprecated Use buildEqualsAny() |
ITextQueryParameter |
buildEqualsAll(String[] criteria)
match every value in the list |
ITextQueryParameter |
buildEqualsAny(String[] criteria)
match any one of the list of values |
ITextQueryParameter |
buildNotEquals(String value)
Matches when the specified criteria does not exist in the full text of a property's binary content. |
ITextQueryParameter |
buildNotEqualsAll(String[] values)
Matches a binary, whem all of specified values do not exist in the free text |
ITextQueryParameter |
buildNotEqualsAny(String[] values)
Matches a binary, whem any of specified values do not exist in the free text |
ITextQueryParameter |
buildRelatedTo(String criteria)
Used for conceptual matching |
ITextQueryParameter |
buildRelatedToAll(String[] criteria)
Used for conceptual matching of all values in a list |
ITextQueryParameter |
buildSimilarTo(String criteria)
Used for "similar", possibly misspelled text |
ITextQueryParameter |
buildSoundsLike(String criteria)
Used for soundex search. |
Method Detail |
---|
ITextQueryParameter buildEquals(String criteria) throws InvalidQueryException
criteria
- The criteria to check.
InvalidQueryException
- If the criteria given builds an invalid query.@Deprecated ITextQueryParameter buildEquals(String[] criteria) throws InvalidQueryException
criteria
- The criteria to check.
InvalidQueryException
- if used. Use buildEqualsAny() or buildEqualsAll()ITextQueryParameter buildEqualsAny(String[] criteria) throws InvalidQueryException
criteria
- The criteria to check.
InvalidQueryException
- If the criteria given builds an invalid query.ITextQueryParameter buildEqualsAll(String[] criteria) throws InvalidQueryException
criteria
- The criteria to check.
InvalidQueryException
- If the criteria given builds an invalid query.ITextQueryParameter buildSoundsLike(String criteria) throws InvalidQueryException
criteria
- The keyword
InvalidQueryException
- If the criteria given builds an invalid query.ITextQueryParameter buildSimilarTo(String criteria) throws InvalidQueryException
criteria
- The criteria to check.
InvalidQueryException
- If the criteria given builds an invalid query.ITextQueryParameter buildRelatedTo(String criteria) throws InvalidQueryException
criteria
- The criteria to check.
InvalidQueryException
- If the criteria given builds an invalid query.ITextQueryParameter buildRelatedToAll(String[] criteria) throws InvalidQueryException
criteria
- list of values for conceptual matching
InvalidQueryException
- If the criteria given builds an invalid query.ITextQueryParameter buildNotEquals(String value) throws InvalidQueryException
Note that if a Node has more than one property, exclusion will only work for the property that matches the parameter excluded and not for the rest of the properties associated with the node. So, a node may still be returned by a query excluding the single property since the other properties don't match the exclusion.
value
- The value which does not exist in the full text
InvalidQueryException
- If the criteria given builds an invalid query.ITextQueryParameter buildNotEqualsAll(String[] values) throws InvalidQueryException
Note that if a Node has more than one property, exclusion will only work for the property that matches the parameter(s) excluded and not for the rest of the properties associated with the node. So, a node may still be returned by a query excluding the single property since the other properties don't match the exclusion.
values
- The list of criteria which do not exist in the free text
InvalidQueryException
- If the criteria given builds an invalid query.ITextQueryParameter buildNotEqualsAny(String[] values) throws InvalidQueryException
Note that if a Node has more than one property, exclusion will only work for the property that matches the parameter(s) excluded and not for the rest of the properties associated with the node. So, a node may still be returned by a query excluding the single property since the other properties don't match the exclusion.
values
- The list of criteria which do not exist in the free text
InvalidQueryException
- If the criteria given builds an invalid query.ITextQueryParameter buildContains(String criteria) throws InvalidQueryException
criteria
- The criteria to check.
InvalidQueryException
- If the criteria given builds an invalid query.ITextQueryParameter buildContainsAny(String[] criteria) throws InvalidQueryException
criteria
- The criteria to check.
InvalidQueryException
- If the criteria given builds an invalid query.ITextQueryParameter buildContainsAll(String[] criteria) throws InvalidQueryException
criteria
- The criteria to check.
InvalidQueryException
- If the criteria given builds an invalid query.
|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |