com.belladati.sdk.dataset.Attribute Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sdk-api Show documentation

The BellaDati SDK allows accessing a BellaDati server from 3rd-party applications using Java. This project contains the SDK's interface definitions.

There is a newer version: 0.9.15.1

Show newest version

package com.belladati.sdk.dataset;

import com.belladati.sdk.filter.Filter;
import com.belladati.sdk.filter.FilterOperation;
import com.belladati.sdk.report.AttributeValue;
import com.belladati.sdk.util.CachedCollection;
import com.belladati.sdk.util.CachedList;
import com.belladati.sdk.util.Resource;
import com.belladati.sdk.view.View;

/**
 * An attribute from a BellaDati data set. Attributes can contain data in
 * various formats.
 * 
 * Attributes can be used to filter the data used in reports by certain
 * attribute values. Refer to the {@link Filter} and {@link FilterOperation}
 * classes to create filters, and to {@link View#loadContent(Filter...)} to use
 * them loading report views.
 * 
 * @author Chris Hennigfeld
 */
public interface Attribute extends Resource {

	/**
	 * Returns the human-readable name of this attribute.
	 * 
	 * @return the human-readable name of this attribute
	 */
	String getName();

	/**
	 * Returns the internal code of this attribute.
	 * 
	 * @return the internal code of this attribute
	 */
	String getCode();

	/**
	 * Returns the possible values for this attribute. This is a cached list,
	 * call {@link CachedCollection#loadFirstTime()} to populate it initially.
	 * 
	 * @return all possible values for this attribute
	 */
	CachedList getValues();

	/**
	 * Returns the type of this attribute.
	 * 
	 * @return the type of this attribute
	 */
	AttributeType getType();
}