*** This API provides Binary Compatibility only, not Source Compatibility ***

com.sas.services.publish.metadata
Class PackageFilter

java.lang.Object
  |
  +--com.sas.services.information.Filter
        |
        +--com.sas.services.information.metadata.KeywordFilter
              |
              +--com.sas.services.publish.metadata.PackageFilter

All Implemented Interfaces:

FilterInterface,

public class PackageFilter

extends KeywordFilter

This class extends KeywordFilter to provide a convenient mechanism to search for package objects in multiple repository types. It allows searching on name, description, name/value pairs, the abstract, and the owning channel. Due to restrictions in the searching capabilities of the Metadata Server, only one of the abstract, channel, and name/value pairs can be searched on at once. If more than one is set, the order of preference is channel, name/value pairs and abstract. Also, exclusion on the basis of name value pairs doesn't work with the Metadata Server or a WebDAV server.

Since:

1.0

See Also:

Serialized Form

Fields inherited from class com.sas.services.information.metadata.KeywordFilter

_keywords

Fields inherited from class com.sas.services.information.Filter

_component

Fields inherited from interface com.sas.services.information.FilterInterface

BASE_SCOPE, FLAG_OVERRIDE, ONELEVEL_SCOPE, SUBTREE_SCOPE

Constructor Summary

PackageFilter()

PackageFilter(String key, int relation, String value)

Method Summary

void	clearNameValuePairs()
void	excludeNameValuePair(String name, String value)
ChannelInterface	getChannel()
String	getDAVBasicSearchString() Get the filter in the form of a DAV basicsearch XML request.
String	getDAVSQLString() Get the filter in the form of a DAV SQL request.
String	getDAVType() Get the DAV type string.
String	getLdapBase() Get the LDAP search base.
String	getLdapString() Get an LDAP filter string.
String	getLDAPType() Get the LDAP type string.
String	getOMRType() Get the OMR type.
String	getXMLSelectString() Get the filter in the form of an XMLSelect statement.
void	includeNameValuePair(String name, String value)
void	setAbstract(String abstractString, int operation) Add search by description.
void	setChannel(ChannelInterface channel)
void	setDescription(String description, int operation) Add search by description.

Methods inherited from class com.sas.services.information.metadata.KeywordFilter

addKeyword, getKeywordSelectString, removeKeyword

Methods inherited from class com.sas.services.information.Filter

component2Select, getDAVBase, getDAVScope, getFilterString, getLdapScope, getName, getOMRFlags, getOMROption, getOMRRepository, getOMRTemplate, getType, getXPathString, setDAVBase, setDAVScope, setFilterComponent, setLdapBase, setLdapScope, setName, setOMRFlags, setOMROption, setOMRRepository, setOMRTemplate, setType, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PackageFilter

public PackageFilter()

PackageFilter

public PackageFilter(String key,
                     int relation,
                     String value)

Method Detail

includeNameValuePair

public void includeNameValuePair(String name,
                                 String value)

excludeNameValuePair

public void excludeNameValuePair(String name,
                                 String value)

clearNameValuePairs

public void clearNameValuePairs()

getOMRType

public String getOMRType()

Description copied from class: Filter

Get the OMR type. Return the type by default. subclasses may override this to return a different string. This method is mostly for use by the OMIRepository class.

Overrides:

getOMRType in class Filter

Following copied from class: com.sas.services.information.Filter

Returns:

The OMR specific type to search for.

getLDAPType

public String getLDAPType()

Description copied from class: Filter

Get the LDAP type string. Return the type by default. Subclasses may override this to return a different string. This method is mostly for use by the LdapRepository class.

Overrides:

getLDAPType in class Filter

Following copied from class: com.sas.services.information.Filter

Returns:

The LDAP specific type to search for.

getDAVType

public String getDAVType()

Description copied from class: Filter

Get the DAV type string. Return the type by default. Subclasses may override this to return a different string. This method is for use by the DAVRepository class.

Overrides:

getDAVType in class Filter

Following copied from class: com.sas.services.information.Filter

Returns:

the DAV specific type to search for.

getChannel

public ChannelInterface getChannel()

setChannel

public void setChannel(ChannelInterface channel)

setDescription

public void setDescription(String description,
                           int operation)

Add search by description.

Parameters:

description - The text to search for in the description.

operation - Either FilterComponent.EQUALS or FilterComponent.CONTAINS

setAbstract

public void setAbstract(String abstractString,
                        int operation)

Add search by description.

Parameters:

abstractString - The text to search for in the description.

operation - Either FilterComponent.EQUALS or FilterComponent.CONTAINS

getXMLSelectString

public String getXMLSelectString()

Get the filter in the form of an XMLSelect statement.

Overrides:

getXMLSelectString in class KeywordFilter

Returns:

An XMLSelect string to pass to OMR.

getLdapBase

public String getLdapBase()

Description copied from class: Filter

Get the LDAP search base.

Overrides:

getLdapBase in class Filter

Following copied from class: com.sas.services.information.Filter

Returns:

The search base to use for this search.

getLdapString

public String getLdapString()

Description copied from class: Filter

Get an LDAP filter string.

Overrides:

getLdapString in class Filter

Following copied from class: com.sas.services.information.Filter

Returns:

An LDAP compatible filter string.

getDAVBasicSearchString

public String getDAVBasicSearchString()

Description copied from class: Filter

Get the filter in the form of a DAV basicsearch XML request. This is described in the WebDAV SEARCH proposal.

Overrides:

getDAVBasicSearchString in class Filter

Following copied from class: com.sas.services.information.Filter

Returns:

An XML basicsearch request to pass to a DAV server.

getDAVSQLString

public String getDAVSQLString()

Description copied from class: Filter

Get the filter in the form of a DAV SQL request. This is aimed at the Microsoft servers - Internet Information Server, SharePoint Portal Server and Exchange server.

Overrides:

getDAVSQLString in class Filter

Following copied from class: com.sas.services.information.Filter

Returns:

An XML DAV SQL request to pass to a DAV server.

*** This API provides Binary Compatibility only, not Source Compatibility ***