com.atlassian.jira.sharing

Class SharedEntityColumnDefinition

java.lang.Object

com.atlassian.jira.sharing.SharedEntityColumnDefinition

@Immutable
public class SharedEntityColumnDefinition
extends Object

Implementation details of a SharedEntityColumn which is used for sorting Shared Entity search results.

Note: the sortColumn is used for equality/hashCode and MUST be distinct.

Since:

v3.13 - was broken out from SharedEntityColumn in v5.0

See Also:

SharedEntityColumn

Field Summary

Fields

Modifier and Type	Field and Description
static SharedEntityColumnDefinition	DESCRIPTION
static SharedEntityColumnDefinition	FAVOURITE_COUNT
static SharedEntityColumnDefinition	ID
static SharedEntityColumnDefinition	IS_SHARED
static SharedEntityColumnDefinition	NAME
static SharedEntityColumnDefinition	OWNER

Method Summary

Modifier and Type	Method and Description
org.apache.lucene.search.FieldComparatorSource	createSortComparator()
static SharedEntityColumnDefinition	definitionFor(SharedEntityColumn column) Returns the definition details for the given SharedEntityColumn.
boolean	equals(Object o)
String	getCaseInsensitiveColumn()
String	getName()
String	getSortColumn()
org.apache.lucene.search.SortField.Type	getSortType()
int	hashCode()
boolean	isCustomSort()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ID

public static final SharedEntityColumnDefinition ID

NAME

public static final SharedEntityColumnDefinition NAME

DESCRIPTION

public static final SharedEntityColumnDefinition DESCRIPTION

OWNER

public static final SharedEntityColumnDefinition OWNER

FAVOURITE_COUNT

public static final SharedEntityColumnDefinition FAVOURITE_COUNT

IS_SHARED

public static final SharedEntityColumnDefinition IS_SHARED

Method Detail

getName

public String getName()

Returns:

the column (field) name

getSortColumn

public String getSortColumn()

Returns:

the column (field) name used for sorting

getSortType

public org.apache.lucene.search.SortField.Type getSortType()

Returns:

the SortField int used to determine the comparison algorithm

getCaseInsensitiveColumn

public String getCaseInsensitiveColumn()

isCustomSort

public boolean isCustomSort()

createSortComparator

public org.apache.lucene.search.FieldComparatorSource createSortComparator()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

definitionFor

public static SharedEntityColumnDefinition definitionFor(SharedEntityColumn column)

Returns the definition details for the given SharedEntityColumn.

Parameters:

column - The simple SharedEntityColumn

Returns:

the definition details for the given SharedEntityColumn.