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 org.apache.directory.shared.i18n.I18n;
026    import org.apache.directory.shared.ldap.entry.StringValue;
027    import org.apache.directory.shared.ldap.entry.Value;
028    import org.apache.directory.shared.ldap.exception.LdapException;
029    import org.apache.directory.shared.ldap.exception.LdapInvalidAttributeValueException;
030    import org.apache.directory.shared.ldap.message.ResultCodeEnum;
031    import org.apache.directory.shared.ldap.schema.Normalizer;
032    import org.apache.directory.shared.ldap.schema.PrepareString;
033    
034    
035    /**
036     * Normalizer which trims down whitespace replacing multiple whitespace
037     * characters on the edges and within the string with a single space character
038     * thereby preserving tokenization order - while doing all this in the same pass
039     * it lower cases all characters.
040     * 
041     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
042     * @version $Rev: 928945 $
043     */
044    public class DeepTrimToLowerNormalizer extends Normalizer
045    {
046        /** The serial UID */
047        public static final long serialVersionUID = 1L;
048    
049        /**
050         * Creates a new instance of DeepTrimToLowerNormalizer.
051         * 
052         * @param oid The MR OID to use with this Normalizer
053         */
054        public DeepTrimToLowerNormalizer( String oid )
055        {
056            super( oid );
057        }
058    
059    
060        /**
061         * Creates a new instance of DeepTrimToLowerNormalizer where the OID is
062         * set after instantiation.
063         */
064        public DeepTrimToLowerNormalizer()
065        {
066        }
067    
068    
069        /**
070         * {@inheritDoc}
071         */
072        public Value<?> normalize( Value<?> value ) throws LdapException
073        {
074            if ( value == null )
075            {
076                return null;
077            }
078    
079            try
080            {
081                String normalized = PrepareString.normalize( value.getString(),
082                    PrepareString.StringType.CASE_IGNORE );
083                
084                return new StringValue( normalized );
085            }
086            catch ( IOException ioe )
087            {
088                throw new LdapInvalidAttributeValueException( ResultCodeEnum.INVALID_ATTRIBUTE_SYNTAX, I18n.err( I18n.ERR_04224, value ) );
089            }
090        }
091    
092    
093        /**
094         * {@inheritDoc}
095         */
096        public String normalize( String value ) throws LdapException
097        {
098            if ( value == null )
099            {
100                return null;
101            }
102    
103            try
104            {
105                String normalized = PrepareString.normalize( value,
106                    PrepareString.StringType.CASE_IGNORE );
107                
108                return normalized;
109            }
110            catch ( IOException ioe )
111            {
112                throw new LdapInvalidAttributeValueException( ResultCodeEnum.INVALID_ATTRIBUTE_SYNTAX, I18n.err( I18n.ERR_04224,  value ) );
113            }
114        }
115    }