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 - while doing all this in the same pass
038     * it lower cases all characters.
039     * 
040     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
041     * @version $Rev: 912436 $
042     */
043    public class DeepTrimToLowerNormalizer extends Normalizer
044    {
045        /** The serial UID */
046        public static final long serialVersionUID = 1L;
047    
048        /**
049         * Creates a new instance of DeepTrimToLowerNormalizer.
050         * 
051         * @param oid The MR OID to use with this Normalizer
052         */
053        public DeepTrimToLowerNormalizer( String oid )
054        {
055            super( oid );
056        }
057    
058    
059        /**
060         * Creates a new instance of DeepTrimToLowerNormalizer where the OID is
061         * set after instantiation.
062         */
063        public DeepTrimToLowerNormalizer()
064        {
065        }
066    
067    
068        /**
069         * {@inheritDoc}
070         */
071        public Value<?> normalize( Value<?> value ) throws NamingException
072        {
073            if ( value == null )
074            {
075                return null;
076            }
077    
078            try
079            {
080                String normalized = PrepareString.normalize( value.getString(),
081                    PrepareString.StringType.CASE_IGNORE );
082                
083                return new ClientStringValue( normalized );
084            }
085            catch ( IOException ioe )
086            {
087                throw new NamingException( I18n.err( I18n.ERR_04224, value ) );
088            }
089        }
090    
091    
092        /**
093         * {@inheritDoc}
094         */
095        public String normalize( String value ) throws NamingException
096        {
097            if ( value == null )
098            {
099                return null;
100            }
101    
102            try
103            {
104                String normalized = PrepareString.normalize( value,
105                    PrepareString.StringType.CASE_IGNORE );
106                
107                return normalized;
108            }
109            catch ( IOException ioe )
110            {
111                throw new NamingException( I18n.err( I18n.ERR_04224,  value ) );
112            }
113        }
114    }