JobStatusFilter.java example

Explorer
eu.geclipse.core-master
/******************************************************************************
 * Copyright (c) 2007 g-Eclipse consortium 
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Initial development of the original code was made for
 * project g-Eclipse founded by European Union
 * project number: FP6-IST-034327  http://www.geclipse.eu/
 *
 * Contributor(s):
 *     Mariusz Wojtysiak - initial API and implementation
 *     
 *****************************************************************************/
package eu.geclipse.ui.views.filters;

import java.util.HashMap;
import java.util.Iterator;

import org.eclipse.jface.viewers.Viewer;
import org.eclipse.ui.IMemento;

import eu.geclipse.core.model.IGridJob;
import eu.geclipse.core.model.IGridJobStatus;

/**
 * Filter using job-status to filter jobs
 */
public class JobStatusFilter extends AbstractGridViewerFilter {

  private static final String MEMENTO_TYPE_STATUS = "Status"; //$NON-NLS-1$
  private static final String MEMENTO_KEY_STATUS_SHOW = "Show"; //$NON-NLS-1$  
  private HashMap<Integer, Boolean> statusMap = new HashMap<Integer, Boolean>();

  /**
   * 
   */
  public JobStatusFilter() {
    // empty implementation
  }

  @SuppressWarnings("unchecked")
  public IGridFilter makeClone() throws CloneNotSupportedException {
    JobStatusFilter newFilter = ( JobStatusFilter )super.clone();
    newFilter.statusMap = ( HashMap<Integer, Boolean> )this.statusMap.clone();
    return newFilter;
  }

  /**
   * @param jobStatus
   * @param showOnView true if jobs with given jobStatus should be visibled on
   *            view
   */
  public void setStatusState( final int jobStatus, final boolean showOnView ) {
    this.statusMap.put( Integer.valueOf( jobStatus ),
                        Boolean.valueOf( showOnView ) );
  }

  @Override
  public boolean select( final Viewer viewer,
                         final Object parentElement,
                         final Object element )
  {
    boolean showOnView = true;
    if( element instanceof IGridJob ) {
      IGridJob job = ( IGridJob )element;
      int jobStatus = job.getJobStatus().getType();
      Boolean showOnViewBool = this.statusMap.get( Integer.valueOf( jobStatus ) );
      if( showOnViewBool == null ) {
        showOnView = getStatusState( IGridJobStatus.UNKNOWN );
      } else {
        showOnView = showOnViewBool.booleanValue();
      }
    }
    return showOnView;
  }

  /**
   * @param jobStatus
   * @return true if job with given jobStatus is visibled on view according to
   *         this filter
   */
  public boolean getStatusState( final int jobStatus ) {
    Boolean showOnView = this.statusMap.get( Integer.valueOf( jobStatus ) );
    return showOnView == null || showOnView.booleanValue();
  }

  public void saveState( final IMemento filterMemento ) {
    for( Integer status : this.statusMap.keySet() ) {
      IMemento statusMemento = filterMemento.createChild( MEMENTO_TYPE_STATUS, status.toString() );
      statusMemento.putInteger( MEMENTO_KEY_STATUS_SHOW,
                                getStatusState( status.intValue() ) ? 1 : 0 );
    }
  }

  /*
   * (non-Javadoc)
   * 
   * @see eu.geclipse.ui.views.filters.IGridFilter#isEnabled()
   */
  public boolean isEnabled() {
    // return true if any status is not checked, what means this filter should
    // be used to filter jobs by status
    boolean enabled = false;
    Iterator<Integer> keysIterator = this.statusMap.keySet().iterator();
    while( keysIterator.hasNext() && !enabled ) {
      enabled |= !this.statusMap.get( keysIterator.next() ).booleanValue();
    }
    return enabled;
  }

  public void readState( final IMemento filterMemento ) {
    IMemento[] statusMementos = filterMemento.getChildren( MEMENTO_TYPE_STATUS );
    for( IMemento statusMemento : statusMementos ) {
      Integer statusValue = Integer.valueOf( statusMemento.getID() );
      Integer showOnView = statusMemento.getInteger( MEMENTO_KEY_STATUS_SHOW );
      if( statusValue != null && showOnView != null ) {
        setStatusState( statusValue.intValue(), showOnView.intValue() != 0 );
      }
    }
  }

  static String getId() {
    return "JobStatusFilter"; //$NON-NLS-1$
  }

  /* (non-Javadoc)
   * @see eu.geclipse.ui.views.filters.IGridFilter#getFilterId()
   */
  public String getFilterId() {
    return getId();
  }
}