1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 *
19 */
20 package org.apache.directory.api.ldap.model.schema.normalizers;
21
22
23 import java.io.IOException;
24
25 import org.apache.directory.api.i18n.I18n;
26 import org.apache.directory.api.ldap.model.entry.StringValue;
27 import org.apache.directory.api.ldap.model.entry.Value;
28 import org.apache.directory.api.ldap.model.exception.LdapException;
29 import org.apache.directory.api.ldap.model.exception.LdapInvalidAttributeValueException;
30 import org.apache.directory.api.ldap.model.message.ResultCodeEnum;
31 import org.apache.directory.api.ldap.model.schema.Normalizer;
32 import org.apache.directory.api.ldap.model.schema.PrepareString;
33
34
35 /**
36 * Normalizer which trims down whitespace replacing multiple whitespace
37 * characters on the edges and within the string with a single space character
38 * thereby preserving tokenization order.
39 *
40 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
41 */
42 @SuppressWarnings("serial")
43 public class DeepTrimNormalizer extends Normalizer
44 {
45 /**
46 * Creates a new instance of DeepTrimNormalizer with OID known.
47 *
48 * @param oid The MR OID to use with this Normalizer
49 */
50 public DeepTrimNormalizer( String oid )
51 {
52 super( oid );
53 }
54
55
56 /**
57 * Creates a new instance of DeepTrimNormalizer when the Normalizer must be
58 * instantiated before setting the OID.
59 */
60 public DeepTrimNormalizer()
61 {
62 }
63
64
65 /**
66 * {@inheritDoc}
67 */
68 public Value<?> normalize( Value<?> value ) throws LdapException
69 {
70 try
71 {
72 String normalized = PrepareString.normalize( value.getString(),
73 PrepareString.StringType.DIRECTORY_STRING );
74
75 return new StringValue( normalized );
76 }
77 catch ( IOException ioe )
78 {
79 throw new LdapInvalidAttributeValueException( ResultCodeEnum.INVALID_ATTRIBUTE_SYNTAX, I18n.err(
80 I18n.ERR_04224, value ), ioe );
81 }
82 }
83
84
85 /**
86 * {@inheritDoc}
87 */
88 public String normalize( String value ) throws LdapException
89 {
90 try
91 {
92 String normalized = PrepareString.normalize( value,
93 PrepareString.StringType.DIRECTORY_STRING );
94
95 return normalized;
96 }
97 catch ( IOException ioe )
98 {
99 throw new LdapInvalidAttributeValueException( ResultCodeEnum.INVALID_ATTRIBUTE_SYNTAX, I18n.err(
100 I18n.ERR_04224, value ), ioe );
101 }
102 }
103 }