AbstractInPlaceStringValueEditor.java

/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *  
 *    http://www.apache.org/licenses/LICENSE-2.0
 *  
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License. 
 *  
 */

package org.apache.directory.studio.valueeditors;


import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

import org.apache.directory.studio.ldapbrowser.common.BrowserCommonActivator;
import org.apache.directory.studio.ldapbrowser.common.BrowserCommonConstants;
import org.apache.directory.studio.ldapbrowser.core.model.AttributeHierarchy;
import org.apache.directory.studio.ldapbrowser.core.model.IAttribute;
import org.apache.directory.studio.ldapbrowser.core.model.IValue;
import org.eclipse.jface.resource.ImageDescriptor;
import org.eclipse.jface.viewers.CellEditor;
import org.eclipse.jface.viewers.TextCellEditor;


/**
 * 
 * Abstract base class for value editors that handle string values
 * within the table or tree control. 
 *
 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
 */
public abstract class AbstractInPlaceStringValueEditor extends TextCellEditor implements IValueEditor
{
    /** The name of this value editor */
    private String name;

    /** The image of this value editor */
    private ImageDescriptor imageDescriptor;


    /**
     * Creates a new instance of AbstractInPlaceStringValueEditor.
     */
    protected AbstractInPlaceStringValueEditor()
    {
        super();
    }


    /**
     * Returns true if the user wishes to show raw values rather than
     * user-friendly values. If true the getDisplayValue() methods 
     * should not modify the value.
     *
     * @return true if raw values should be displayed
     */
    protected boolean showRawValues()
    {
        return BrowserCommonActivator.getDefault().getPreferenceStore().getBoolean(
            BrowserCommonConstants.PREFERENCE_SHOW_RAW_VALUES );
    }


    /**
     * {@inheritDoc}
     * 
     * This implementation of getDisplayValue() returns a 
     * comma-separated list of all values. 
     */
    @Override
    public String getDisplayValue( AttributeHierarchy attributeHierarchy )
    {
        if ( attributeHierarchy == null )
        {
            return NULL;
        }

        List<IValue> valueList = new ArrayList<>();
        
        for ( IAttribute attribute : attributeHierarchy )
        {
            valueList.addAll( Arrays.asList( attribute.getValues() ) );
        }

        StringBuilder sb = new StringBuilder();
        boolean isFirst = true;
        
        for ( IValue value : valueList )
        {
            if ( isFirst )
            {
                isFirst = false;
            }
            else
            {
                sb.append( ", " ); //$NON-NLS-1$
            }

            sb.append( getDisplayValue( value ) );
        }
        
        return sb.toString();
    }


    /**
     * {@inheritDoc}
     * 
     * This implementation just returns the raw value
     */
    @Override
    public String getDisplayValue( IValue value )
    {
        Object obj = getRawValue( value );
        return StringValueEditorUtils.getDisplayValue( obj );
    }


    /**
     * {@inheritDoc}
     * 
     * This implementation returns IValue.EMPTY_xx_VALUE if there are no values
     * in attributeHierarchy or calls getRawValue(IValue) if attributeHierarchy
     * contains exactly one value. Otherwise null is returned.
     */
    @Override
    public Object getRawValue( AttributeHierarchy attributeHierarchy )
    {
        if ( ( attributeHierarchy != null ) && ( attributeHierarchy.size() == 1 ) )
        {
            if ( attributeHierarchy.getAttribute().getValueSize() == 0 )
            {
                if ( attributeHierarchy.getAttribute().isString() )
                {
                    return IValue.EMPTY_STRING_VALUE;
                }
                else
                {
                    return IValue.EMPTY_BINARY_VALUE;
                }
            }
            else if ( attributeHierarchy.getAttribute().getValueSize() == 1 )
            {
                return getRawValue( attributeHierarchy.getAttribute().getValues()[0] );
            }
        }

        return null;
    }
    
    
    /**
     * {@inheritDoc}
     */
    @Override
    public boolean hasValue( IValue value )
    {
        return ( value != null ) && ( value.isString() || value.isBinary() );
    }

    
    /**
     * {@inheritDoc}
     * 
     * This implementation returns the string value 
     * of the given value. 
     */
    @Override
    public Object getRawValue( IValue value )
    {
        return StringValueEditorUtils.getRawValue( value );
    }


    /**
     * {@inheritDoc}
     * 
     * This implementation always return the string value
     * as String.
     */
    @Override
    public Object getStringOrBinaryValue( Object rawValue )
    {
        return StringValueEditorUtils.getStringOrBinaryValue( rawValue );
    }


    /**
     * {@inheritDoc}
     */
    @Override
    public CellEditor getCellEditor()
    {
        return this;
    }


    /**
     * {@inheritDoc}
     */
    @Override
    protected Object doGetValue()
    {
        if ( EMPTY.equals( text.getText() ) )
        {
            return null;
        }
        else
        {
            return text.getText();
        }
    }


    /**
     * {@inheritDoc}
     */
    @Override
    protected void doSetValue( Object value )
    {
        if ( value instanceof IValue.EmptyValue )
        {
            super.doSetValue( ( ( IValue.EmptyValue ) value ).getStringValue() );
        }
        else
        {
            super.doSetValue( value );
        }
    }


    /**
     * {@inheritDoc}
     */
    @Override
    public void setValueEditorName( String name )
    {
        this.name = name;
    }


    /**
     * {@inheritDoc}
     */
    @Override
    public String getValueEditorName()
    {
        return name;
    }


    /**
     * {@inheritDoc}
     */
    @Override
    public void setValueEditorImageDescriptor( ImageDescriptor imageDescriptor )
    {
        this.imageDescriptor = imageDescriptor;
    }


    /**
     * {@inheritDoc}
     */
    @Override
    public ImageDescriptor getValueEditorImageDescriptor()
    {
        return imageDescriptor;
    }
}