BooleanDimension.java

/*
 * Copyright 2020 Global Crop Diversity Trust
 *
 * 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.gringlobal.model.kpi;

import java.util.HashSet;
import java.util.Set;

import javax.persistence.Column;
import javax.persistence.Entity;

import com.fasterxml.jackson.annotation.JsonIgnore;
import lombok.Getter;
import lombok.Setter;

/**
 * BooleanDimension is a filter applied to the query to select matching records
 * for calculation of a {@link KPIParameter} with Boolean filters: true or false.
 *
 * <p>
 * <b>Example:</b> To count only accessions with mlsStat==true, a "trueOnly"
 * {@link BooleanDimension} should be configured.
 * </p>
 *
 * <p>
 * There are not that many useful combinations of {@link BooleanDimension}. Most
 * commonly all three possible values will be used: null, true, and false.
 * </p>
 *
 * @author mobreza
 *
 */
@Entity
@Getter
@Setter
public class BooleanDimension extends Dimension<Boolean> {

	private static final long serialVersionUID = -1715418305225067103L;

	@Column
	private int mode = 3;

	@Override
	public Class<Boolean> getTargetType() {
		return Boolean.class;
	}

	@JsonIgnore
	@Override
	public Set<Boolean> getValues() {
		Set<Boolean> b = new HashSet<Boolean>();
		if (hasTrue()) {
			b.add(Boolean.TRUE);
		}
		if (hasFalse()) {
			b.add(Boolean.FALSE);
		}
		return b;
	}

	public boolean hasTrue() {
		return (mode & 1) != 0;
	}

	public void useTrue(boolean use) {
		if (use)
			mode |= 1;
		else
			mode &= ~1;
	}

	public boolean hasFalse() {
		return (mode & 2) != 0;
	}

	public void useFalse(boolean use) {
		if (use)
			mode |= 2;
		else
			mode &= ~2;
	}

	@Override
	public boolean canEqual(Object other) {
		return other instanceof BooleanDimension;
	}

	@Override
	public Dimension<Boolean> apply(Dimension source) {
		this.setMode(((BooleanDimension)source).getMode());
		return super.apply(source);
	}
}