|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.controls.MatchedValuesFilter
public class MatchedValuesFilter
This class defines a filter that may be used in conjunction with the matched values control to indicate which particular values of a multivalued attribute should be returned. The matched values filter is essentially a subset of an LDAP search filter, lacking support for AND, OR, and NOT components, and lacking support for the dnAttributes component of extensible matching filters.
Field Summary | |
---|---|
static byte |
APPROXIMATE_MATCH_TYPE
The BER type associated with the approxMatch filter type. |
static byte |
EQUALITY_MATCH_TYPE
The BER type associated with the equalityMatch filter type. |
static byte |
EXTENSIBLE_MATCH_TYPE
The BER type associated with the extensibleMatch filter type. |
static byte |
GREATER_OR_EQUAL_TYPE
The BER type associated with the greaterOrEqual filter type. |
static byte |
LESS_OR_EQUAL_TYPE
The BER type associated with the lessOrEqual filter type. |
static byte |
PRESENT_TYPE
The BER type associated with the present filter type. |
static byte |
SUBSTRINGS_TYPE
The BER type associated with the substrings filter type. |
Method Summary | |
---|---|
static MatchedValuesFilter |
createApproximateFilter(AttributeType attributeType,
AttributeValue assertionValue)
Creates a new approxMatch filter with the provided information. |
static MatchedValuesFilter |
createApproximateFilter(java.lang.String rawAttributeType,
ByteString rawAssertionValue)
Creates a new approxMatch filter with the provided information. |
static MatchedValuesFilter |
createEqualityFilter(AttributeType attributeType,
AttributeValue assertionValue)
Creates a new equalityMatch filter with the provided information. |
static MatchedValuesFilter |
createEqualityFilter(java.lang.String rawAttributeType,
ByteString rawAssertionValue)
Creates a new equalityMatch filter with the provided information. |
static MatchedValuesFilter |
createExtensibleMatchFilter(AttributeType attributeType,
MatchingRule matchingRule,
AttributeValue assertionValue)
Creates a new extensibleMatch filter with the provided information. |
static MatchedValuesFilter |
createExtensibleMatchFilter(java.lang.String rawAttributeType,
java.lang.String matchingRuleID,
ByteString rawAssertionValue)
Creates a new extensibleMatch filter with the provided information. |
static MatchedValuesFilter |
createFromLDAPFilter(RawFilter filter)
Creates a new matched values filter from the provided LDAP filter. |
static MatchedValuesFilter |
createGreaterOrEqualFilter(AttributeType attributeType,
AttributeValue assertionValue)
Creates a new greaterOrEqual filter with the provided information. |
static MatchedValuesFilter |
createGreaterOrEqualFilter(java.lang.String rawAttributeType,
ByteString rawAssertionValue)
Creates a new greaterOrEqual filter with the provided information. |
static MatchedValuesFilter |
createLessOrEqualFilter(AttributeType attributeType,
AttributeValue assertionValue)
Creates a new lessOrEqual filter with the provided information. |
static MatchedValuesFilter |
createLessOrEqualFilter(java.lang.String rawAttributeType,
ByteString rawAssertionValue)
Creates a new lessOrEqual filter with the provided information. |
static MatchedValuesFilter |
createPresentFilter(AttributeType attributeType)
Creates a new present filter with the provided information. |
static MatchedValuesFilter |
createPresentFilter(java.lang.String rawAttributeType)
Creates a new present filter with the provided information. |
static MatchedValuesFilter |
createSubstringsFilter(AttributeType attributeType,
ByteString subInitial,
java.util.List<ByteString> subAny,
ByteString subFinal)
Creates a new substrings filter with the provided information. |
static MatchedValuesFilter |
createSubstringsFilter(java.lang.String rawAttributeType,
ByteString subInitial,
java.util.List<ByteString> subAny,
ByteString subFinal)
Creates a new substrings filter with the provided information. |
static MatchedValuesFilter |
decode(ASN1Element element)
Decodes the provided ASN.1 element as a matched values filter item. |
ASN1Element |
encode()
Encodes this matched values filter as an ASN.1 element. |
ApproximateMatchingRule |
getApproximateMatchingRule()
Retrieves the approximate matching rule that should be used for this matched values filter. |
AttributeValue |
getAssertionValue()
Retrieves the assertion value for this matched values filter. |
AttributeType |
getAttributeType()
Retrieves the attribute type for this matched values filter. |
EqualityMatchingRule |
getEqualityMatchingRule()
Retrieves the equality matching rule that should be used for this matched values filter. |
MatchingRule |
getMatchingRule()
Retrieves the matching rule for this matched values filter. |
java.lang.String |
getMatchingRuleID()
Retrieves the matching rule ID for this matched values filter. |
byte |
getMatchType()
Retrieves the match type for this matched values filter. |
java.util.List<ASN1OctetString> |
getNormalizedSubAnyElements()
Retrieves the set of normalized subAny elements for this matched values filter. |
ASN1OctetString |
getNormalizedSubFinalElement()
Retrieves the normalized form of the subFinal element. |
ASN1OctetString |
getNormalizedSubInitialElement()
Retrieves the normalized form of the subInitial element. |
OrderingMatchingRule |
getOrderingMatchingRule()
Retrieves the ordering matching rule that should be used for this matched values filter. |
ByteString |
getRawAssertionValue()
Retrieves the raw, unprocessed assertion value for this matched values filter. |
java.lang.String |
getRawAttributeType()
Retrieves the raw, unprocessed attribute type for this matched values filter. |
java.util.List<ByteString> |
getSubAnyElements()
Retrieves the set of subAny elements for this matched values filter. |
ByteString |
getSubFinalElement()
Retrieves the subFinal element for this matched values filter. |
ByteString |
getSubInitialElement()
Retrieves the subInitial element for this matched values filter. |
SubstringMatchingRule |
getSubstringMatchingRule()
Retrieves the substring matching rule that should be used for this matched values filter. |
void |
setAssertionValue(AttributeValue assertionValue)
Specifies the assertion value for this matched values filter. |
void |
setAttributeType(AttributeType attributeType)
Specifies the attribute type for this matched values filter. |
void |
setMatchingRule(MatchingRule matchingRule)
Specifies the matching rule for this matched values filter. |
void |
setMatchingRuleID(java.lang.String matchingRuleID)
Specifies the matching rule ID for this matched values filter. |
void |
setRawAssertionValue(ByteString rawAssertionValue)
Specifies the raw, unprocessed assertion value for this matched values filter. |
void |
setRawAttributeType(java.lang.String rawAttributeType)
Specifies the raw, unprocessed attribute type for this matched values filter. |
void |
setSubAnyElements(java.util.List<ByteString> subAny)
Specifies the set of subAny elements for this matched values filter. |
void |
setSubFinalElement(ByteString subFinal)
Specifies the subFinal element for this matched values filter. |
void |
setSubInitialElement(ByteString subInitial)
Specifies the subInitial element for this matched values filter. |
java.lang.String |
toString()
Retrieves a string representation of this matched values filter, as an RFC 2254-compliant filter string. |
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this matched values filter, as an RFC 2254-compliant filter string, to the provided buffer. |
boolean |
valueMatches(AttributeType type,
AttributeValue value)
Indicates whether the specified attribute value matches the criteria defined in this matched values filter. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final byte EQUALITY_MATCH_TYPE
public static final byte SUBSTRINGS_TYPE
public static final byte GREATER_OR_EQUAL_TYPE
public static final byte LESS_OR_EQUAL_TYPE
public static final byte PRESENT_TYPE
public static final byte APPROXIMATE_MATCH_TYPE
public static final byte EXTENSIBLE_MATCH_TYPE
Method Detail |
---|
public static MatchedValuesFilter createEqualityFilter(java.lang.String rawAttributeType, ByteString rawAssertionValue)
rawAttributeType
- The raw, unprocessed attribute type.rawAssertionValue
- The raw, unprocessed assertion value.
public static MatchedValuesFilter createEqualityFilter(AttributeType attributeType, AttributeValue assertionValue)
attributeType
- The attribute type.assertionValue
- The assertion value.
public static MatchedValuesFilter createSubstringsFilter(java.lang.String rawAttributeType, ByteString subInitial, java.util.List<ByteString> subAny, ByteString subFinal)
rawAttributeType
- The raw, unprocessed attribute type.subInitial
- The subInitial element.subAny
- The set of subAny elements.subFinal
- The subFinal element.
public static MatchedValuesFilter createSubstringsFilter(AttributeType attributeType, ByteString subInitial, java.util.List<ByteString> subAny, ByteString subFinal)
attributeType
- The raw, unprocessed attribute type.subInitial
- The subInitial element.subAny
- The set of subAny elements.subFinal
- The subFinal element.
public static MatchedValuesFilter createGreaterOrEqualFilter(java.lang.String rawAttributeType, ByteString rawAssertionValue)
rawAttributeType
- The raw, unprocessed attribute type.rawAssertionValue
- The raw, unprocessed assertion value.
public static MatchedValuesFilter createGreaterOrEqualFilter(AttributeType attributeType, AttributeValue assertionValue)
attributeType
- The attribute type.assertionValue
- The assertion value.
public static MatchedValuesFilter createLessOrEqualFilter(java.lang.String rawAttributeType, ByteString rawAssertionValue)
rawAttributeType
- The raw, unprocessed attribute type.rawAssertionValue
- The raw, unprocessed assertion value.
public static MatchedValuesFilter createLessOrEqualFilter(AttributeType attributeType, AttributeValue assertionValue)
attributeType
- The attribute type.assertionValue
- The assertion value.
public static MatchedValuesFilter createPresentFilter(java.lang.String rawAttributeType)
rawAttributeType
- The raw, unprocessed attribute type.
public static MatchedValuesFilter createPresentFilter(AttributeType attributeType)
attributeType
- The attribute type.
public static MatchedValuesFilter createApproximateFilter(java.lang.String rawAttributeType, ByteString rawAssertionValue)
rawAttributeType
- The raw, unprocessed attribute type.rawAssertionValue
- The raw, unprocessed assertion value.
public static MatchedValuesFilter createApproximateFilter(AttributeType attributeType, AttributeValue assertionValue)
attributeType
- The attribute type.assertionValue
- The assertion value.
public static MatchedValuesFilter createExtensibleMatchFilter(java.lang.String rawAttributeType, java.lang.String matchingRuleID, ByteString rawAssertionValue)
rawAttributeType
- The raw, unprocessed attribute type.matchingRuleID
- The matching rule ID.rawAssertionValue
- The raw, unprocessed assertion value.
public static MatchedValuesFilter createExtensibleMatchFilter(AttributeType attributeType, MatchingRule matchingRule, AttributeValue assertionValue)
attributeType
- The attribute type.matchingRule
- The matching rule.assertionValue
- The assertion value.
public static MatchedValuesFilter createFromLDAPFilter(RawFilter filter) throws LDAPException
filter
- The LDAP filter to use for this matched values filter.
LDAPException
- If the provided LDAP filter cannot be treated as a
matched values filter.public ASN1Element encode()
public static MatchedValuesFilter decode(ASN1Element element) throws LDAPException
element
- The ASN.1 element to be decoded.
LDAPException
- If a problem occurs while attempting to decode the
filter item.public byte getMatchType()
public java.lang.String getRawAttributeType()
null
if there is none.public void setRawAttributeType(java.lang.String rawAttributeType)
rawAttributeType
- The raw, unprocessed attribute type for this
matched values filter.public AttributeType getAttributeType()
null
if there is none.public void setAttributeType(AttributeType attributeType)
attributeType
- The attribute type for this matched values filter.public ByteString getRawAssertionValue()
null
if there is none.public void setRawAssertionValue(ByteString rawAssertionValue)
rawAssertionValue
- The raw, unprocessed assertion value for this
matched values filter.public AttributeValue getAssertionValue()
null
if there is none.public void setAssertionValue(AttributeValue assertionValue)
assertionValue
- The assertion value for this matched values filter.public ByteString getSubInitialElement()
null
if there is none.public void setSubInitialElement(ByteString subInitial)
subInitial
- The subInitial element for this matched values filter.public ASN1OctetString getNormalizedSubInitialElement()
null
if there is none.public java.util.List<ByteString> getSubAnyElements()
null
or an empty list.public void setSubAnyElements(java.util.List<ByteString> subAny)
subAny
- The set of subAny elements for this matched values filter.public java.util.List<ASN1OctetString> getNormalizedSubAnyElements()
null
will be returned.public ByteString getSubFinalElement()
null
if there is none.public void setSubFinalElement(ByteString subFinal)
subFinal
- The subFinal element for this matched values filter.public ASN1OctetString getNormalizedSubFinalElement()
null
if there is none.public java.lang.String getMatchingRuleID()
null
if there is none.public void setMatchingRuleID(java.lang.String matchingRuleID)
matchingRuleID
- The matching rule ID for this matched values
filter.public MatchingRule getMatchingRule()
null
if there is none.public void setMatchingRule(MatchingRule matchingRule)
matchingRule
- The matching rule for this matched values filter.public ApproximateMatchingRule getApproximateMatchingRule()
null
if there is none.public EqualityMatchingRule getEqualityMatchingRule()
null
if there is none.public OrderingMatchingRule getOrderingMatchingRule()
null
if there is none.public SubstringMatchingRule getSubstringMatchingRule()
null
if there is none.public boolean valueMatches(AttributeType type, AttributeValue value)
type
- The attribute type with which the provided value is
associated.value
- The attribute value for which to make the determination.
true
if the specified attribute value matches the
criteria defined in this matched values filter, or
false
if not.public java.lang.String toString()
toString
in class java.lang.Object
public void toString(java.lang.StringBuilder buffer)
buffer
- The buffer to which the filter string should be appended.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |