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 */
020package org.apache.directory.api.ldap.model.schema.normalizers;
021
022
023import java.io.IOException;
024
025import org.apache.directory.api.i18n.I18n;
026import org.apache.directory.api.ldap.model.entry.StringValue;
027import org.apache.directory.api.ldap.model.entry.Value;
028import org.apache.directory.api.ldap.model.exception.LdapException;
029import org.apache.directory.api.ldap.model.exception.LdapInvalidAttributeValueException;
030import org.apache.directory.api.ldap.model.message.ResultCodeEnum;
031import org.apache.directory.api.ldap.model.schema.Normalizer;
032import org.apache.directory.api.ldap.model.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 */
043@SuppressWarnings("serial")
044public class DeepTrimToLowerNormalizer extends Normalizer
045{
046    /**
047     * Creates a new instance of DeepTrimToLowerNormalizer.
048     * 
049     * @param oid The MR OID to use with this Normalizer
050     */
051    public DeepTrimToLowerNormalizer( String oid )
052    {
053        super( oid );
054    }
055
056
057    /**
058     * Creates a new instance of DeepTrimToLowerNormalizer where the OID is
059     * set after instantiation.
060     */
061    public DeepTrimToLowerNormalizer()
062    {
063    }
064
065
066    /**
067     * {@inheritDoc}
068     */
069    public Value<?> normalize( Value<?> value ) throws LdapException
070    {
071        if ( value == null )
072        {
073            return null;
074        }
075
076        try
077        {
078            String normalized = PrepareString.normalize( value.getString(),
079                PrepareString.StringType.CASE_IGNORE );
080
081            return new StringValue( normalized );
082        }
083        catch ( IOException ioe )
084        {
085            throw new LdapInvalidAttributeValueException( ResultCodeEnum.INVALID_ATTRIBUTE_SYNTAX, I18n.err(
086                I18n.ERR_04224, value ), ioe );
087        }
088    }
089
090
091    /**
092     * {@inheritDoc}
093     */
094    public String normalize( String value ) throws LdapException
095    {
096        if ( value == null )
097        {
098            return null;
099        }
100
101        try
102        {
103            String normalized = PrepareString.normalize( value,
104                PrepareString.StringType.CASE_IGNORE );
105
106            return normalized;
107        }
108        catch ( IOException ioe )
109        {
110            throw new LdapInvalidAttributeValueException( ResultCodeEnum.INVALID_ATTRIBUTE_SYNTAX, I18n.err(
111                I18n.ERR_04224, value ), ioe );
112        }
113    }
114}