/*
* 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.ldapbrowser.common.widgets.entryeditor;
import org.apache.directory.studio.ldapbrowser.common.BrowserCommonActivator;
import org.apache.directory.studio.ldapbrowser.core.model.IAttribute;
import org.apache.directory.studio.ldapbrowser.core.model.IRootDSE;
import org.apache.directory.studio.ldapbrowser.core.model.IValue;
import org.eclipse.jface.viewers.TreeViewer;
import org.eclipse.jface.viewers.Viewer;
import org.eclipse.jface.viewers.ViewerFilter;
/**
* The EntryEditorWidgetFilter implements the filter for
* the entry editor widget.
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
* @version $Rev$, $Date$
*/
public class EntryEditorWidgetFilter extends ViewerFilter
{
/** The viewer to filter. */
protected TreeViewer viewer;
/** The quick filter attribute. */
protected String quickFilterAttribute;
/** The quick filter value. */
protected String quickFilterValue;
/**
* Creates a new instance of EntryEditorWidgetFilter.
*/
public EntryEditorWidgetFilter()
{
this.quickFilterAttribute = ""; //$NON-NLS-1$
this.quickFilterValue = ""; //$NON-NLS-1$
}
/**
* Connects this filter with the given viewer.
*
* @param viewer the viewer
*/
public void connect( TreeViewer viewer )
{
this.viewer = viewer;
viewer.addFilter( this );
}
/**
* {@inheritDoc}
*/
public boolean select( Viewer viewer, Object parentElement, Object element )
{
if ( element instanceof IAttribute )
{
IAttribute attribute = ( IAttribute ) element;
// check if one of the values goes through the quick filter
boolean oneGoesThrough = false;
IValue[] values = attribute.getValues();
for ( int i = 0; i < values.length; i++ )
{
if ( goesThroughQuickFilter( values[i] ) )
{
oneGoesThrough = true;
break;
}
}
if ( !oneGoesThrough )
{
return false;
}
// check attribute category
if ( !goesThroughtCategoryFilter( attribute ) )
{
return false;
}
}
else if ( element instanceof IValue )
{
IValue value = ( IValue ) element;
// check quick filter
if ( !goesThroughQuickFilter( value ) )
{
return false;
}
// check attribute category
if ( !goesThroughtCategoryFilter( value.getAttribute() ) )
{
return false;
}
}
return true;
}
/**
* Checks if the given value goes through quick filter.
*
* @param value the value
*
* @return true, if goes through quick filter
*/
private boolean goesThroughQuickFilter( IValue value )
{
// filter attribute description
if ( quickFilterAttribute != null && !"".equals( quickFilterAttribute ) ) //$NON-NLS-1$
{
if ( value.getAttribute().getDescription().toUpperCase().indexOf( quickFilterAttribute.toUpperCase() ) == -1 )
{
return false;
}
}
// fitler value
if ( quickFilterValue != null && !"".equals( quickFilterValue ) ) //$NON-NLS-1$
{
if ( value.isString()
&& value.getStringValue().toUpperCase().indexOf( quickFilterValue.toUpperCase() ) == -1 )
{
return false;
}
else if ( value.isBinary() )
{
return false;
}
}
return true;
}
/**
* Checks if the given attribute goes through attribute category filter.
*
* @param attribute the attribute
*
* @return true, if goes through attribute category filter
*/
private boolean goesThroughtCategoryFilter( IAttribute attribute )
{
if ( attribute.isObjectClassAttribute() )
{
return isShowObjectClassAttribute() || ( attribute.getEntry() instanceof IRootDSE );
}
else if ( attribute.isMustAttribute() )
{
return isShowMustAttributes() || ( attribute.getEntry() instanceof IRootDSE );
}
else if ( attribute.isMayAttribute() )
{
return isShowMayAttributes() || ( attribute.getEntry() instanceof IRootDSE );
}
else if ( attribute.isOperationalAttribute() )
{
return isShowOperationalAttributes() || ( attribute.getEntry() instanceof IRootDSE );
}
else
{
return true;
}
}
/**
* Disposes this filter.
*/
public void dispose()
{
viewer = null;
}
/**
* Gets the quick filter attribute.
*
* @return the quick filter attribute
*/
public String getQuickFilterAttribute()
{
return quickFilterAttribute;
}
/**
* Sets the quick filter attribute.
*
* @param quickFilterAttribute the quick filter attribute
*/
public void setQuickFilterAttribute( String quickFilterAttribute )
{
if ( !this.quickFilterAttribute.equals( quickFilterAttribute ) )
{
String oldValue = this.quickFilterAttribute;
this.quickFilterAttribute = quickFilterAttribute;
BrowserCommonActivator.getDefault().getPreferenceStore().firePropertyChangeEvent(
"QuickFilterAttributeChanged", oldValue, quickFilterAttribute ); //$NON-NLS-1$
}
}
/**
* Gets the quick filter value.
*
* @return the quick filter value
*/
public String getQuickFilterValue()
{
return quickFilterValue;
}
/**
* Sets the quick filter value.
*
* @param quickFilterValue the quick filter value
*/
public void setQuickFilterValue( String quickFilterValue )
{
if ( !this.quickFilterValue.equals( quickFilterValue ) )
{
String oldValue = this.quickFilterValue;
this.quickFilterValue = quickFilterValue;
BrowserCommonActivator.getDefault().getPreferenceStore().firePropertyChangeEvent(
"QuickFilterValueChanged", oldValue, quickFilterAttribute ); //$NON-NLS-1$
}
}
/**
* Checks if may attributes should be shown.
*
* @return true, if may attributes should be shown
*/
public boolean isShowMayAttributes()
{
return true;
}
/**
* Checks if must attributes should be shown.
*
* @return true, if must attributes should be shown
*/
public boolean isShowMustAttributes()
{
return true;
}
/**
* Checks if the objectClass attribute should be shown.
*
* @return true, if the objectClass attribute should be shown
*/
public boolean isShowObjectClassAttribute()
{
return true;
}
/**
* Checks if operational attributes should be shown.
*
* @return true, if operational attributes should be shown
*/
public boolean isShowOperationalAttributes()
{
return true;
}
}