org.broadleafcommerce.openadmin.client.dto.FilterAndSortCriteria Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of broadleaf-open-admin-platform Show documentation
BroadleafCommerce Open Admin Platform
There is a newer version: 3.1.15-GA
Show newest version
/*
 * Copyright 2008-2012 the original author or authors.
 *
 * 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.broadleafcommerce.openadmin.client.dto;

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

import com.google.gwt.user.client.rpc.IsSerializable;

/**
 * Basic client-side persistent entity criteria
 * representation for a single property of the
 * target persistent entity.
 * 
 * 
 * 
 * This class is essentially an analogy of server-side
 * property criteria regarding the filtering
 * and sorting functionality.
 * 
 * 

 * 
 * Back on the server side, persistent entity property
 * mappings are used to resolve:
 * 
 * 

 * 	symbolic persistent entity property identifier
 * 		(propertyId) into the corresponding
 *      associationPath / targetPropertyName
 *      combination
 * 	
array of string-based filter values into
 *      appropriate typed object representations
 *      (integers, dates, etc.)
 * 
 * 
 * Note that the propertyId of each
 * {@link FilterAndSortCriteria} instance must be
 * unique within the {@link CriteriaTransferObject}.
 * 
 * @see CriteriaTransferObject
 * 
 * @author vojtech.szocs
 */
public class FilterAndSortCriteria implements IsSerializable, Serializable {

    private static final long serialVersionUID = -593864722147943119L;
    
    private String propertyId;
	
	private List filterValues = new ArrayList();
	
	private Boolean sortAscending;
    private Boolean ignoreCase;
    
    /**
     * Creates a new persistent entity criteria
     * (for deserialization purposes only).
     */
    protected FilterAndSortCriteria() {
        // nothing to do here
    }
    
	/**
	 * Creates a new persistent entity criteria.
	 * 
	 * @param propertyId Symbolic persistent entity property
	 * identifier.
	 */
	public FilterAndSortCriteria(String propertyId) {
		this.propertyId = propertyId;
	}
	
	/**
	 * @return Symbolic persistent entity property identifier.
	 */
	public String getPropertyId() {
		return propertyId;
	}
	
	/**
	 * @return Array of string-based filter values.
	 */
	public String[] getFilterValues() {
		return filterValues.toArray(new String[0]);
	}
	
	/**
	 * Clears any filter value(s) set previously
	 * to this criteria.
	 */
	public void clearFilterValues() {
        filterValues.clear();
	}
	
	/**
	 * Sets a single filter value to this criteria,
	 * replacing any filter value(s) set previously.
	 * 
	 * @param value String-based filter value.
	 */
	public void setFilterValue(String value) {
	    clearFilterValues();
	    filterValues.add(value);
	}
	
	/**
	 * Sets multiple filter values to this criteria,
     * replacing any filter value(s) set previously.
     * 
	 * @param values String-based filter values.
	 */
	public void setFilterValues(String... values) {
	    clearFilterValues();
	    filterValues.addAll(Arrays.asList(values));
	}
	
	/**
	 * @return true for ascending, false
	 * for descending sort order or null to disable
	 * the sorting functionality.
	 */
	public Boolean getSortAscending() {
		return sortAscending;
	}
	
	/**
	 * @param sortAscending true for ascending,
	 * false for descending sort order or null
	 * to disable the sorting functionality.
	 */
	public void setSortAscending(Boolean sortAscending) {
		this.sortAscending = sortAscending;
	}
	
	/**
	 * @return true for case-insensitive sorting,
	 * false for case-sensitive sorting (applicable
	 * only when sortAscending is not null).
	 */
	public Boolean getIgnoreCase() {
		return ignoreCase;
	}
	
	/**
	 * @param ignoreCase true for case-insensitive
	 * sorting, false for case-sensitive sorting
	 * (applicable only when sortAscending is not
	 * null).
	 */
	public void setIgnoreCase(Boolean ignoreCase) {
		this.ignoreCase = ignoreCase;
	}
	
}