001    /*
002     *  Licensed to the Apache Software Foundation (ASF) under one
003     *  or more contributor license agreements.  See the NOTICE file
004     *  distributed with this work for additional information
005     *  regarding copyright ownership.  The ASF licenses this file
006     *  to you under the Apache License, Version 2.0 (the
007     *  "License"); you may not use this file except in compliance
008     *  with the License.  You may obtain a copy of the License at
009     *
010     *    http://www.apache.org/licenses/LICENSE-2.0
011     *
012     *  Unless required by applicable law or agreed to in writing,
013     *  software distributed under the License is distributed on an
014     *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015     *  KIND, either express or implied.  See the License for the
016     *  specific language governing permissions and limitations
017     *  under the License.
018     *
019     */
020    package org.apache.directory.shared.ldap.schema.normalizers;
021    
022    
023    import java.io.IOException;
024    
025    import javax.naming.NamingException;
026    
027    import org.apache.directory.shared.i18n.I18n;
028    import org.apache.directory.shared.ldap.entry.Value;
029    import org.apache.directory.shared.ldap.entry.client.ClientStringValue;
030    import org.apache.directory.shared.ldap.schema.Normalizer;
031    import org.apache.directory.shared.ldap.schema.PrepareString;
032    
033    
034    /**
035     * Normalizer which trims down whitespace replacing multiple whitespace
036     * characters on the edges and within the string with a single space character
037     * thereby preserving tokenization order.
038     *
039     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
040     * @version $Rev: 912436 $
041     */
042    public class DeepTrimNormalizer extends Normalizer
043    {
044        /** The serial UID */
045        public static final long serialVersionUID = 1L;
046    
047        
048        /**
049         * Creates a new instance of DeepTrimNormalizer with OID known.
050         * 
051         * @param oid The MR OID to use with this Normalizer
052         */
053        public DeepTrimNormalizer( String oid )
054        {
055            super( oid );
056        }
057    
058    
059        /**
060         * Creates a new instance of DeepTrimNormalizer when the Normalizer must be
061         * instantiated before setting the OID.
062         */
063        public DeepTrimNormalizer()
064        {
065        }
066    
067    
068    
069       /**
070        * {@inheritDoc}
071        */
072       public Value<?> normalize( Value<?> value ) throws NamingException
073       {
074           try
075           {
076               String normalized = PrepareString.normalize( value.getString(), 
077                   PrepareString.StringType.DIRECTORY_STRING ); 
078               
079               return new ClientStringValue( normalized ); 
080           }
081           catch ( IOException ioe )
082           {
083               throw new NamingException( I18n.err( I18n.ERR_04224, value ) );
084           }
085       }
086    
087    
088       /**
089        * {@inheritDoc}
090        */
091       public String normalize( String value ) throws NamingException
092       {
093           try
094           {
095               String normalized = PrepareString.normalize( value, 
096                   PrepareString.StringType.DIRECTORY_STRING ); 
097               
098               return normalized; 
099           }
100           catch ( IOException ioe )
101           {
102               throw new NamingException( I18n.err( I18n.ERR_04224, value ) );
103           }
104       }
105    }