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 import org.apache.directory.shared.ldap.constants.SchemaConstants;
023 import org.apache.directory.shared.ldap.entry.StringValue;
024 import org.apache.directory.shared.ldap.entry.Value;
025 import org.apache.directory.shared.ldap.exception.LdapException;
026 import org.apache.directory.shared.ldap.schema.Normalizer;
027 import org.apache.directory.shared.ldap.util.StringTools;
028
029
030 /**
031 * A normalizer which transforms an escape sequence into an internal
032 * canonical form: into UTF-8 characters presuming the escape sequence
033 * fits that range. This is used explicity for non-binary attribute
034 * types only.
035 *
036 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
037 * @version $Rev$, $Date$
038 */
039 public class DefaultStringNormalizer extends Normalizer
040 {
041 // The serial UID
042 private static final long serialVersionUID = 1L;
043
044 /** A default String normalizer */
045 private static final DefaultStringNormalizer NORMALIZER = new DefaultStringNormalizer();
046
047 protected DefaultStringNormalizer()
048 {
049 // TODO : This is probably not the correct OID ...
050 super( SchemaConstants.CASE_IGNORE_MATCH_MR_OID );
051 }
052
053
054 /**
055 * {@inheritDoc}
056 */
057 public Value<?> normalize( Value<?> value ) throws LdapException
058 {
059 String str = value.getString();
060
061 if ( StringTools.isEmpty( str ) )
062 {
063 return new StringValue( str );
064 }
065
066 return new StringValue( str );
067 }
068
069
070 /**
071 * {@inheritDoc}
072 */
073 public String normalize( String value ) throws LdapException
074 {
075 if ( StringTools.isEmpty( value ) )
076 {
077 return value;
078 }
079
080 return value;
081 }
082
083
084 /**
085 * Normalize the given String
086 *
087 * @param string The string to normalize
088 * @return The normalized object
089 * @throws LdapException If the normalization throws an error
090 */
091 public static String normalizeString( String string ) throws LdapException
092 {
093 return NORMALIZER.normalize( string );
094 }
095 }