FieldFilterHelper.java :  » Web-Framework » aranea-mvc-1.1.1 » org » araneaframework » uilib » list » structure » filter » Java Open Source

Java Open Source » Web Framework » aranea mvc 1.1.1 
aranea mvc 1.1.1 » org » araneaframework » uilib » list » structure » filter » FieldFilterHelper.java
/**
 * Copyright 2006 Webmedia Group Ltd.
 *
 * Licensed 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.araneaframework.uilib.list.structure.filter;

import org.araneaframework.core.Assert;
import org.araneaframework.uilib.form.Control;
import org.araneaframework.uilib.form.FormElement;
import org.araneaframework.uilib.list.ListWidget;
import org.araneaframework.uilib.list.TypeHelper;

/**
 * One list field specific proxy for {@link FilterHelper}.
 * 
 * @author <a href="mailto:rein@araneaframework.org">Rein Raudjrv</a>
 * 
 * @see FilterHelper
 * @see ListWidget
 */
public class FieldFilterHelper extends BaseFilterHelper {
  
  private final FilterHelper helper;
  private final String fieldId; 
  
  /**
   * Constructs a {@link FieldFilterHelper} for specified {@link FilterHelper}
   * and field.
   * 
   * @param helper filter helper.
   * @param fieldId list field id.
   */
  public FieldFilterHelper(FilterHelper helper, String fieldId) {
    super(helper.list);
    
    Assert.notNullParam(helper, "helper");
    Assert.notEmptyParam(fieldId, "fieldId");
    
    this.helper = helper;
    this.fieldId = fieldId;
  }
  
  /**
   * Returns the {@link FilterHelper} that this {@link FieldFilterHelper} is
   * based on.
   * 
   * @return the filter helper.
   */
  public FilterHelper getFilterHelper() {
    return this.helper;
  }
  
  /**
   * Sets the current case sensitivity behaivor.
   * 
   * @param ignoreCase whether to ignore case.
   */
  public FieldFilterHelper setIgnoreCase(boolean ignoreCase) {
    super._setIgnoreCase(ignoreCase);
    return this;
  }
  
//  /**
//   * Sets the current locale.
//   * 
//   * @param locale new locale.
//   */
//  public FieldFilterHelper setLocale(Locale locale) {
//    super._setLocale(locale);
//    return this;
//  }
  
  /**
   * Sets the current strickness behaivor.
   * 
   * @param strict whether new filters should be strict.
   */
  public FieldFilterHelper setStrict(boolean strict) {
    super._setStrict(strict);
    return this;
  }
  
  /**
   * Adds custom label for current field. This can override already defined
   * label of list field. Those labels are used by new filter form elements
   * that are automatically created for list filters. 
   * 
   * @param labelId label id (not yet resolved).
   */
  public FieldFilterHelper useCustomLabel(String labelId) {
    super._addCustomLabel(fieldId, labelId);
    return this;
  }

  /**
   * Defines type for current field.
   * 
   * @param type field type.
   * 
   * @see TypeHelper#addFieldType(String, Class)
   */
  public FieldFilterHelper useFieldType(Class type) {
    super._addFieldType(fieldId, type);
    return this;
  }
  
  // ========== EQUALS ========== 
  
  // filter with form element
  
  public FilterHelper eq() {
    return this.helper.eq(fieldId);
  }
  public FilterHelper eq(String valueId) {
    return this.helper.eq(fieldId, valueId);
  }
  public FilterHelper eq(Control control) {
    return this.helper.eq(fieldId, control);
  }
  public FilterHelper eq(String valueId, Control control) {
    return this.helper.eq(fieldId, valueId, control);
  }
  public FilterHelper eq(FormElement element) {
    return this.helper.eq(fieldId, element);
  }
  public FilterHelper eq(String valueId, FormElement element) {
    return this.helper.eq(fieldId, valueId, element);
  }
  
  // filter
  
  public FilterHelper _eq() {
    return this.helper._eq(fieldId);
  }
  public FilterHelper _eq(String valueId) {
    return this.helper._eq(fieldId, valueId);
  }

  // constant filter

  public FilterHelper eqConst(Object value) {
    return this.helper.eqConst(fieldId, value);
  }
  public FilterHelper eqConst(String valueId, Object value) {
    return this.helper.eqConst(fieldId, valueId, value);
  }
  
  // ========== GREATER THAN ========== 
  
  // filter with form element
  
  public FilterHelper gt() {
    return this.helper.gt(fieldId);
  }
  public FilterHelper gt(String valueId) {
    return this.helper.gt(fieldId, valueId);
  }
  public FilterHelper gt(Control control) {
    return this.helper.gt(fieldId, control);
  }
  public FilterHelper gt(String valueId, Control control) {
    return this.helper.gt(fieldId, valueId, control);
  }
  public FilterHelper gt(FormElement element) {
    return this.helper.gt(fieldId, element);
  }
  public FilterHelper gt(String valueId, FormElement element) {
    return this.helper.gt(fieldId, valueId, element);
  }
  
  // filter
  
  public FilterHelper _gt() {
    return this.helper._gt(fieldId);
  }
  public FilterHelper _gt(String valueId) {
    return this.helper._gt(fieldId, valueId);
  }

  // constant filter

  public FilterHelper gtConst(Object value) {
    return this.helper.gtConst(fieldId, value);
  }
  public FilterHelper gtConst(String valueId, Object value) {
    return this.helper.gtConst(fieldId, valueId, value);
  }  
  
  // ========== LOWER THAN ========== 
  
  // filter with form element
  
  public FilterHelper lt() {
    return this.helper.lt(fieldId);
  }
  public FilterHelper lt(String valueId) {
    return this.helper.lt(fieldId, valueId);
  }
  public FilterHelper lt(Control control) {
    return this.helper.lt(fieldId, control);
  }
  public FilterHelper lt(String valueId, Control control) {
    return this.helper.lt(fieldId, valueId, control);
  }
  public FilterHelper lt(FormElement element) {
    return this.helper.lt(fieldId, element);
  }
  public FilterHelper lt(String valueId, FormElement element) {
    return this.helper.lt(fieldId, valueId, element);
  }
  
  // filter
  
  public FilterHelper _lt() {
    return this.helper._lt(fieldId);
  }
  public FilterHelper _lt(String valueId) {
    return this.helper._lt(fieldId, valueId);
  }

  // constant filter

  public FilterHelper ltConst(Object value) {
    return this.helper.ltConst(fieldId, value);
  }
  public FilterHelper ltConst(String valueId, Object value) {
    return this.helper.ltConst(fieldId, valueId, value);
  }
    
  // ========== LIKE ==========
  
  // filter with form element
  
  public FilterHelper like() {
    return this.helper.like(fieldId);
  }
  public FilterHelper like(String valueId) {
    return this.helper.like(fieldId, valueId);
  }
  public FilterHelper like(Control control) {
    return this.helper.like(fieldId, control);
  }
  public FilterHelper like(String valueId, Control control) {
    return this.helper.like(fieldId, valueId, control);
  }
  public FilterHelper like(FormElement element) {
    return this.helper.like(fieldId, element);
  }
  public FilterHelper like(String valueId, FormElement element) {
    return this.helper.like(fieldId, valueId, element);
  }
  
  // filter
  
  public FilterHelper _like() {
    return this.helper._like(fieldId);
  }
  public FilterHelper _like(String valueId) {
    return this.helper._like(fieldId, valueId);
  }

  // constant filter

  public FilterHelper likeConst(Object value) {
    return this.helper.likeConst(fieldId, value);
  }
  public FilterHelper likeConst(String valueId, Object value) {
    return this.helper.likeConst(fieldId, valueId, value);
  }
  
  // ========== IS NULL ========== 
  
  // fiisNuller with form element
  
  public FilterHelper isNull(Object conditionValue) {
    return this.helper.isNull(fieldId, conditionValue);
  }
  public FilterHelper isNull(String valueId, Object conditionValue) {
    return this.helper.isNull(fieldId, valueId, conditionValue);
  }
  public FilterHelper isNull(Object conditionValue, Control control) {
    return this.helper.isNull(fieldId, conditionValue, control);
  }
  public FilterHelper isNull(String valueId, Object conditionValue, Control control) {
    return this.helper.isNull(fieldId, valueId, conditionValue, control);
  }
  public FilterHelper isNull(Object conditionValue, FormElement element) {
    return this.helper.isNull(fieldId, conditionValue, element);
  }
  public FilterHelper isNull(String valueId, Object conditionValue, FormElement element) {
    return this.helper.isNull(fieldId, valueId, conditionValue, element);
  }
  
  // fiisNuller
  
  public FilterHelper _isNull(Object conditionValue) {
    return this.helper._isNull(fieldId, conditionValue);
  }
  public FilterHelper _isNull(String valueId, Object conditionValue) {
    return this.helper._isNull(fieldId, valueId, conditionValue);
  }

  // constant fiisNuller

  public FilterHelper isNullConst() {
    return this.helper.isNullConst(fieldId);
  }
  
  // ========== NOT NULL ========== 
  
  // fiisNuller with form element
  
  public FilterHelper notNull(Object conditionValue) {
    return this.helper.notNull(fieldId, conditionValue);
  }
  public FilterHelper notNull(String valueId, Object conditionValue) {
    return this.helper.notNull(fieldId, valueId, conditionValue);
  }
  public FilterHelper notNull(Object conditionValue, Control control) {
    return this.helper.notNull(fieldId, conditionValue, control);
  }
  public FilterHelper notNull(String valueId, Object conditionValue, Control control) {
    return this.helper.notNull(fieldId, valueId, conditionValue, control);
  }
  public FilterHelper notNull(Object conditionValue, FormElement element) {
    return this.helper.notNull(fieldId, conditionValue, element);
  }
  public FilterHelper notNull(String valueId, Object conditionValue, FormElement element) {
    return this.helper.notNull(fieldId, valueId, conditionValue, element);
  }
  
  // finotNuller
  
  public FilterHelper _notNull(Object conditionValue) {
    return this.helper._notNull(fieldId, conditionValue);
  }
  public FilterHelper _notNull(String valueId, Object conditionValue) {
    return this.helper._notNull(fieldId, valueId, conditionValue);
  }

  // constant finotNuller

  public FilterHelper notNullConst() {
    return this.helper.notNullConst(fieldId);
  }
    
  // ========== RANGE ==========
  
  // filter with form element
  
  public FilterHelper range() {
    return this.helper.range(fieldId);
  }
  public FilterHelper range(String lowValueId, String highValueId) {
    return this.helper.range(fieldId, lowValueId, highValueId);
  }
  public FilterHelper range(Control lowControl, Control highControl) {
    return this.helper.range(fieldId, lowControl, highControl);
  }
  public FilterHelper range(String lowValueId, String highValueId, Control lowControl, Control highControl) {
    return this.helper.range(fieldId, lowValueId, highValueId, lowControl, highControl);
  }
  public FilterHelper range(FormElement lowElement, FormElement highElement) {
    return this.helper.range(fieldId, lowElement, highElement);
  }
  public FilterHelper range(String lowValueId, String highValueId, FormElement lowElement, FormElement highElement) {
    return this.helper.range(fieldId, lowValueId, highValueId, lowElement, highElement);
  }
  
  // filter
  
  public FilterHelper _range() {
    return this.helper._range(fieldId);
  }
  public FilterHelper _range(String lowValueId, String highValueId) {
    return this.helper._range(fieldId, lowValueId, highValueId);
  }
  
}
java2s.com  | Contact Us | Privacy Policy
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.