netscape.ldap.client

Class JDAPFilterSubString

java.lang.Object

netscape.ldap.client.JDAPFilter

netscape.ldap.client.JDAPFilterSubString

public class JDAPFilterSubString
extends JDAPFilter

This class implements the filter substring. See RFC 1777 and 2254.

 [4] SEQUENCE {
   type AttributeType,
   SEQUENCE OF CHOICE {
     initial [0] LDAPString,
     any [1] LDAPString,
     final [2] LDAPString
   }
 }

 substring  = attr "=" [initial] any [final]
 initial    = value
 any        = "*" *(value "*")
 final      = value
 

Version:

1.0

Constructor Summary

Constructors

Constructor and Description
JDAPFilterSubString(java.lang.String type) Constructs the filter.

Method Summary

Modifier and Type	Method and Description
void	addAny(java.lang.String s) Adds any substring.
void	addFinal(java.lang.String s) Adds final substring.
void	addInitial(java.lang.String s) Adds initial substring.
java.util.Collection<java.lang.String>	getAnySubstrings() Get any substrings.
BERElement	getBERElement() Gets ber representation of the filter.
java.lang.String	getFinalSubstring() Get final substring.
java.lang.String	getInitialSubstring() Get initial substring.
java.lang.String	getType() Get attribute type.
java.lang.String	toString() Gets string reprensetation of the filter.

Methods inherited from class netscape.ldap.client.JDAPFilter

getFilter, getFilterComp, getFilterItem, getFilterList

Methods inherited from class java.lang.Object

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

Constructor Detail

JDAPFilterSubString

public JDAPFilterSubString(java.lang.String type)

Constructs the filter.

Parameters:

type - attribute type

Method Detail

getType

public java.lang.String getType()

Get attribute type.

Returns:

attribute type

getInitialSubstring

public java.lang.String getInitialSubstring()

Get initial substring.

Returns:

initial substring.

addInitial

public void addInitial(java.lang.String s)

Adds initial substring.

Parameters:

s - initial substring

getAnySubstrings

public java.util.Collection<java.lang.String> getAnySubstrings()

Get any substrings.

Returns:

any substrings.

addAny

public void addAny(java.lang.String s)

Adds any substring.

Parameters:

s - any substring

getFinalSubstring

public java.lang.String getFinalSubstring()

Get final substring.

Returns:

final substring.

addFinal

public void addFinal(java.lang.String s)

Adds final substring.

Parameters:

s - final substring

getBERElement

public BERElement getBERElement()

Gets ber representation of the filter.

Specified by:

getBERElement in class JDAPFilter

Returns:

ber representation

toString

public java.lang.String toString()

Gets string reprensetation of the filter.

Specified by:

toString in class JDAPFilter

Returns:

string representation