org.sonar.api.web
Class FilterColumn

java.lang.Object
  org.sonar.api.web.FilterColumn

public final class FilterColumn
extends Object

Definition of a Filter column.

Since:

3.1

Field Summary

static String	ASC
static String	DESC
static Set<String>	DIRECTIONS

Method Summary

static FilterColumn	create(String family, String key, String sortDirection, boolean variation) Creates a new FilterColumn.
String	getFamily() Get the the column's family.
String	getKey() Get the the column's key.
String	getSortDirection() Get the the column's sort direction.
boolean	isVariation() A column can be based on the variation of a value rather than on the value itself.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ASC

public static final String ASC

See Also:

Constant Field Values

DESC

public static final String DESC

See Also:

Constant Field Values

DIRECTIONS

public static final Set<String> DIRECTIONS

Method Detail

create

public static FilterColumn create(String family,
                                  String key,
                                  String sortDirection,
                                  boolean variation)

Creates a new FilterColumn.

Valid values for the sortDirection are #ASC, #DESC

When the @{see Filter} is persisted, a validation is made on the family and the key. They should point to a valid column description.

Throws:

IllegalArgumentException - if sortDirection is not valid

getFamily

public String getFamily()

Get the the column's family.

Returns:

the family

getKey

public String getKey()

Get the the column's key.

Returns:

the key

getSortDirection

public String getSortDirection()

Get the the column's sort direction.

Returns:

the sort direction

isVariation

public boolean isVariation()

A column can be based on the variation of a value rather than on the value itself.

Returns:

true when the variation is used rather than the value