Searching Internationalized Entries

Sun OpenDS Standard Edition supports collation rules that match entries and can be used with the server-side sorting control to sort search results. The collation rule is specified in the search filter as a matching rule, delimited by colons, as shown here:

locale.matchingRule

where:

• locale is specified in one of the following ways

  • Locale OID

  • Locale character suffix (such as ar, en, or fr-CA).

    See Supported Collation Rules at the end of this section for a list of supported locales, their OIDs, and tags.

• matchingRule can specified as either a numeric suffix or a character suffix appended to the locale, as listed in Table 1.

  ---

  Note - If the locale is specified by its OID, then the matching rule must be specified by its numeric suffix. In this case, the matching rule cannot be specified by the character suffix.

  ---

Table 1

Matching Rule Suffixes

Equality is the default matching rule. That is, when no matching rule suffix is specified, the collation rule uses equality matching rule. The two following examples are equivalent and specify the English collation rule and the equality matching rule, but the second example specifies the equality matching rule explicitly with the .eq suffix:

"cn:en:=sanchez"
"cn:en.eq:=sanchez"

The next example shows the same search filter, but specified using the locale's character suffix and the matching rule's numeric code:

"cn:en.3:=sanchez"

The following example shows the same search filter specified using the locale OID and the matching rule numeric suffix:

"cn:1.3.6.1.4.1.42.2.27.9.4.34.1.3:=sanchez"

The following examples specify the same search filter but with a Spanish collation rule.

"cn:es.eq:=sanchez"
"cn:1.3.6.1.4.1.42.2.27.9.4.49.1.3:=sanchez"
"cn:es.3:=sanchez"

The following examples specify a similar search filter that uses a greater-than matching rule with the Spanish collation rule.

"cn:es.gt:=sanchez"
"cn:1.3.6.1.4.1.42.2.27.9.4.49.1.5:=sanchez"
"cn:es.5:=sanchez"

Examples

Example 8

Equality Search

The following search uses a filter with the en (en-US) locale OID to perform an equality search to return any entry with a cn value of sanchez:

$ ldapsearch -D "cn=directory manager" -w password -b "o=test" \
  "cn:1.3.6.1.4.1.42.2.27.9.4.34.1:=sanchez"

The following filters return the same results:

• "cn:en:=sanchez"

• "cn:en.3:=sanchez"

• "cn:en.eq:=sanchez"

• "cn:1.3.6.1.4.1.42.2.27.9.4.34.1.3:=sanchez"

Example 9

Less-Than Search

The following search uses a filter with the es (es-ES) locale and performs a less-than search and returns the entry with a departmentnumbervalue of abc119:

$ ldapsearch -D "cn=directory manager" -w password -b "o=test" \
  "departmentnumber:1.3.6.1.4.1.42.2.27.9.4.49.1.1:=abc120"

The following filters return the same results:

• "departmentnumber:es.1:=abc120"

• "departmentnumber:es.lt:=abc120"

Example 10

Less-Than-or-Equal-To Search

The following search uses a filter with the es (es-ES) locale and performs a less-than-or-equal-to search that returns the entry with a departmentnumbervalue of abc119:

$ ldapsearch -D "cn=directory manager" -w password -b "o=test" \
  "departmentnumber:1.3.6.1.4.1.42.2.27.9.4.49.1.2:=abc119"

The following filters return the same results:

• "departmentnumber:es.2:=abc119"

• "departmentnumber:es.lte:=abc119"

Example 11

Greater-Than-or-Equal-To Search

The following search uses a filter with the fr (fr-FR) locale and performs a greater-than-or-equal-To search that returns an entry with a departmentnumber value of abc119

$ ldapsearch -D "cn=directory manager" -w password -b "o=test" \
  "departmentnumber:fr.4:=abc119"

The following filters return the same results:

• "departmentnumber:1.3.6.1.4.1.42.2.27.9.4.76.1.4:=abc119"

• "departmentnumber:fr.gte:=abc119"

Example 12

Greater-Than Search

The following search uses a filter with the fr (fr-FR) locale and performs a greater-than search:

$ ldapsearch -D "cn=directory manager" -w password -b "o=test" \
  "departmentnumber:fr.5:=abc119"

The above search should not return an entry with a departmentnumber value of abc119.

The following filters return the same results:

• "departmentnumber:1.3.6.1.4.1.42.2.27.9.4.76.1.5:=abc119"

• "departmentnumber:fr.gt:=abc119"

Example 13

Substring Search

The following search uses a filter with the en (en-US) locale and performs a substring search that returns an entry with an sn value of “Quebec”:

$ ldapsearch -D "cn=directory manager" -w password -b "o=test" \
  "sn:en.6:=*u*bec"

The following filters return the same results:

• "sn:1.3.6.1.4.1.42.2.27.9.4.34.1.6:=*u*bec"

• "sn:en.sub:=*u*bec"

Supported Collation Rules

The following table lists the internationalization locales supported by Sun OpenDS Standard Edition and the Sun JVM, alphabetized by character suffix.

Table 2

Supported Collation Rules