NumericCriteria.java

/*
 * Copyright (c) 1998-2017 by Richard A. Wilkes. All rights reserved.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, version 2.0. If a copy of the MPL was not distributed with
 * this file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This Source Code Form is "Incompatible With Secondary Licenses", as
 * defined by the Mozilla Public License, version 2.0.
 */

package com.trollworks.gcs.criteria;

import com.trollworks.toolkit.annotation.Localize;
import com.trollworks.toolkit.io.xml.XMLReader;
import com.trollworks.toolkit.io.xml.XMLWriter;
import com.trollworks.toolkit.utility.Localization;
import com.trollworks.toolkit.utility.text.Enums;

import java.io.IOException;

/** Manages numeric comparison criteria. */
public abstract class NumericCriteria {
	@Localize("is ")
	@Localize(locale = "de", value = "ist ")
	@Localize(locale = "ru", value = "  ")
	@Localize(locale = "es", value = "es ")
	private static String IS_PREFIX;

	static {
		Localization.initialize();
	}

	/** The comparison attribute. */
	public static final String	ATTRIBUTE_COMPARE	= "compare";	//$NON-NLS-1$
	private NumericCompareType	mType;

	/**
	 * Creates a new numeric comparison.
	 *
	 * @param type The {@link NumericCompareType} to use.
	 */
	public NumericCriteria(NumericCompareType type) {
		setType(type);
	}

	@Override
	public boolean equals(Object obj) {
		if (obj == this) {
			return true;
		}
		if (obj instanceof NumericCriteria) {
			return mType == ((NumericCriteria) obj).mType;
		}
		return false;
	}

	@Override
	public int hashCode() {
		return super.hashCode();
	}

	/**
	 * Loads data.
	 *
	 * @param reader The reader to load data from.
	 */
	@SuppressWarnings("unused")
	public void load(XMLReader reader) throws IOException {
		setType(Enums.extract(reader.getAttribute(ATTRIBUTE_COMPARE), NumericCompareType.values(), NumericCompareType.AT_LEAST));
	}

	/**
	 * Saves this object as XML to a stream.
	 *
	 * @param out The XML writer to use.
	 * @param tag The tag to use.
	 */
	public void save(XMLWriter out, String tag) {
		out.simpleTagWithAttribute(tag, getQualifierAsString(false), ATTRIBUTE_COMPARE, Enums.toId(mType));
	}

	/**
	 * @param allowAdornments Whether extras, such as "lbs." can be appended to the text.
	 * @return The numeric qualifier, as a {@link String}.
	 */
	public abstract String getQualifierAsString(boolean allowAdornments);

	/** @return The type of comparison to make. */
	public NumericCompareType getType() {
		return mType;
	}

	/** @param type The type of comparison to make. */
	public void setType(NumericCompareType type) {
		mType = type;
	}

	@Override
	public String toString() {
		return toString(IS_PREFIX);
	}

	/**
	 * @param prefix A prefix to place before the description.
	 * @return A formatted description of this object.
	 */
	public String toString(String prefix) {
		return mType.format(prefix, getQualifierAsString(true));
	}
}