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.
039 *
040 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
041 */
042@SuppressWarnings("serial")
043public class DeepTrimNormalizer extends Normalizer
044{
045    /**
046     * Creates a new instance of DeepTrimNormalizer with OID known.
047     * 
048     * @param oid The MR OID to use with this Normalizer
049     */
050    public DeepTrimNormalizer( String oid )
051    {
052        super( oid );
053    }
054
055
056    /**
057     * Creates a new instance of DeepTrimNormalizer when the Normalizer must be
058     * instantiated before setting the OID.
059     */
060    public DeepTrimNormalizer()
061    {
062    }
063
064
065    /**
066     * {@inheritDoc}
067     */
068    @Override
069    public Value<?> normalize( Value<?> value ) throws LdapException
070    {
071        try
072        {
073            String normalized = PrepareString.normalize( value.getString(),
074                PrepareString.StringType.DIRECTORY_STRING );
075
076            return new StringValue( normalized );
077        }
078        catch ( IOException ioe )
079        {
080            throw new LdapInvalidAttributeValueException( ResultCodeEnum.INVALID_ATTRIBUTE_SYNTAX, I18n.err(
081                I18n.ERR_04224, value ), ioe );
082        }
083    }
084
085
086    /**
087     * {@inheritDoc}
088     */
089    @Override
090    public String normalize( String value ) throws LdapException
091    {
092        try
093        {
094            return PrepareString.normalize( value, PrepareString.StringType.DIRECTORY_STRING );
095        }
096        catch ( IOException ioe )
097        {
098            throw new LdapInvalidAttributeValueException( ResultCodeEnum.INVALID_ATTRIBUTE_SYNTAX, I18n.err(
099                I18n.ERR_04224, value ), ioe );
100        }
101    }
102}