|
Foundation |
|
| |||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface FilterInterface
The FilterInterface describes a means for setting and getting information used to limit the results of a search against a repository. While it would be nice to make it completely repository-neutral, there are concepts and mechanisms that just don't translate.
Field Summary | |
---|---|
static int |
BASE_SCOPE
|
static java.lang.String |
FILTERCOMPONENT_UNSUPPORTED
This string will be returned from a Filter method that returns a search string as an indicator that one more more filter components were not supported for the repository type that was searched. |
static int |
FLAG_OVERRIDE
Most searches use a default set of flags that generally result in the most useful results set. |
static int |
ONELEVEL_SCOPE
|
static java.lang.String |
PROTOCOL_DAV
|
static java.lang.String |
PROTOCOL_HIBERNATE
|
static java.lang.String |
PROTOCOL_IPOD
|
static java.lang.String |
PROTOCOL_LDAP
|
static java.lang.String |
PROTOCOL_OMI
This is a list of the known repository protocols. |
static int |
SUBTREE_SCOPE
|
Method Summary | |
---|---|
void |
addProtocol(java.lang.String protocol)
Add a protocol string to the list to be searched (e.g., "omi", "dav"). |
void |
addSearchOption(java.lang.String name,
java.lang.Object option)
Add a search option. |
java.lang.String |
getDAVBase()
Get the DAV search base. |
java.lang.String |
getDAVBasicSearchString()
Get the filter in the form of a DAV basicsearch XML request. |
int |
getDAVScope()
Get the scope of the search for DAV searches. |
java.lang.String |
getDAVSQLString()
Get the filter in the form of a DAV SQL XML request. |
java.lang.String |
getDAVType()
Get the DAV specific type. |
java.lang.String |
getExplicitSearchString()
Get the explicit search string set by the client. |
FilterComponent |
getFilterComponent()
Get the FilterComponent for this filter. |
java.lang.String |
getFilterString()
Gets a generic filter string. |
java.lang.String |
getJCRXPathString()
Get an XPath string to use to filter a search against OMR. |
java.lang.String |
getName()
Get the name of the object to look for. |
int |
getOMRFlags()
Get the flags to pass to the OMR GetMetadata operation. |
java.lang.String |
getOMROption()
Get the OMR option string. |
java.lang.String |
getOMRRepository()
Get the ID of the repository to search. |
java.lang.String |
getOMRSearchString()
Returns the OMR specific search string for this filter. |
java.lang.String |
getOMRTemplate()
Get a template string used to format the data coming back from OMR. |
java.lang.String |
getOMRType()
Get the OMR specific type. |
java.util.List |
getProtocols()
Get the List of protocols that were set to be searched. |
java.lang.String |
getRdbmsTable()
Get the relational database table to search. |
java.util.Map |
getSearchOptions()
Get the Map of search options for this Filter. |
java.lang.String |
getType()
Get the type of object to search for. |
java.lang.String |
getXMLSelectString()
Get the filter in the form of an XMLSelect statement. |
java.lang.String |
getXPathString()
Get an XPath string to use to filter a search against OMR. |
void |
removeProtocol(java.lang.String protocol)
Remove a protocol from the list. |
void |
removeSearchOption(java.lang.String name)
Remove the named search option. |
void |
setDAVBase(java.lang.String base)
Set the DAV search base. |
void |
setDAVScope(int scope)
Set the DAV search scope. |
void |
setExplicitSearchString(java.lang.String protocol,
java.lang.String searchString)
If the client knows exactly the search string they want to use, they may set it here. |
void |
setFilterComponent(FilterComponent component)
Add a component to this filter. |
void |
setName(java.lang.String name)
Set the name of the object to search for. |
void |
setOMRFlags(int flags)
Set flags to pass to the OMR GetMetadata operation. |
void |
setOMROption(java.lang.String option)
Set the OMR option string. |
void |
setOMRRepository(java.lang.String reposid)
Set the ID of the repository to search. |
void |
setOMRTemplate(java.lang.String template)
Set the OMR template. |
void |
setProtocols(java.util.List protocols)
Set the list of protocols to search. |
void |
setRdbmsTable(java.lang.String table)
For Relational searches, set the table name to search. |
void |
setType(java.lang.String type)
Set the type to search for. |
Field Detail |
---|
static final java.lang.String PROTOCOL_OMI
static final java.lang.String PROTOCOL_DAV
static final java.lang.String PROTOCOL_LDAP
static final java.lang.String PROTOCOL_IPOD
static final java.lang.String PROTOCOL_HIBERNATE
static final int BASE_SCOPE
static final int ONELEVEL_SCOPE
static final int SUBTREE_SCOPE
static final java.lang.String FILTERCOMPONENT_UNSUPPORTED
static final int FLAG_OVERRIDE
Method Detail |
---|
void setFilterComponent(FilterComponent component)
component
- The new component to add to this filter.FilterComponent getFilterComponent()
void setType(java.lang.String type)
type
- The object type to search for.java.lang.String getOMRType()
java.lang.String getDAVType()
java.lang.String getType()
void setName(java.lang.String name)
name
- The object name.java.lang.String getName()
java.lang.String getFilterString()
java.lang.String getOMRSearchString()
java.lang.String getXMLSelectString()
java.lang.String getXPathString()
java.lang.String getJCRXPathString()
java.lang.String getOMRTemplate()
void setOMRTemplate(java.lang.String template)
template
- The template to pass to OMR to format results.java.lang.String getOMROption()
void setOMROption(java.lang.String option)
option
- The string to pass to OMR as options.void setOMRFlags(int flags)
flags
- Flag(s) to set on the GetMetadata.int getOMRFlags()
java.lang.String getOMRRepository()
void setOMRRepository(java.lang.String reposid)
reposid
- The ID of the repository to search.void setDAVBase(java.lang.String base)
base
- The search base for searches represented by this filter.java.lang.String getDAVBase()
int getDAVScope()
void setDAVScope(int scope)
scope
- The new scope of the search.java.lang.String getDAVBasicSearchString()
java.lang.String getDAVSQLString()
void setRdbmsTable(java.lang.String table)
table
- The relational table to search for objects.java.lang.String getRdbmsTable()
void addProtocol(java.lang.String protocol)
protocol
- A protocol string to control the types of repositories
to search.void removeProtocol(java.lang.String protocol)
protocol
- The protocol string to remove.void setProtocols(java.util.List protocols)
protocols
- A List of protocol Strings (e.g., "omi", "dav").java.util.List getProtocols()
void setExplicitSearchString(java.lang.String protocol, java.lang.String searchString)
protocol
- The protocol for which the search string is to be
used.searchString
- The search string to be used for the search.java.lang.String getExplicitSearchString()
void addSearchOption(java.lang.String name, java.lang.Object option)
name
- The name of the option to be added.option
- The option value. This is usually a String, but
may be other object types.void removeSearchOption(java.lang.String name)
name
- The name of the option to remove.java.util.Map getSearchOptions()
|
Foundation |
|
| |||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |