sirius.db.mixing.query

Class QueryTag

java.lang.Object

sirius.db.mixing.query.QueryTag

public class QueryTag
extends Object

Can be embedded in a query parsed by the QueryCompiler.

Constructor Summary

Constructors

Constructor and Description
QueryTag(String type, String color, String value, String label) Creates a new tag.

Method Summary

Modifier and Type	Method and Description
String	getColor() Returns the color or CSS class used to render this tag.
String	getLabel() Returns the label shown to the user.
String	getType() The type of the tag, used to identify the QueryTagHandler to use.
String	getValue() Returns the filter value passed to the QueryTagHandler.
static QueryTag	parse(String tag) Parses the tag from a given search query.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryTag

public QueryTag(String type,
                String color,
                String value,
                String label)

Creates a new tag.

Parameters:

type - the type of the tag, used to identify the QueryTagHandler to use

color - the color used to render the tag in the search box

value - the value passed to the QueryTagHandler

label - the value shown to the user

Method Detail

parse

public static QueryTag parse(String tag)

Parses the tag from a given search query.

Parameters:

tag - the tag to parse, see toString()

Returns:

the parsed tag

getType

public String getType()

The type of the tag, used to identify the QueryTagHandler to use.

Returns:

the type of the tag

getValue

public String getValue()

Returns the filter value passed to the QueryTagHandler.

Returns:

the effective filter value

getLabel

public String getLabel()

Returns the label shown to the user.

Returns:

the label used to represent this tag

getColor

public String getColor()

Returns the color or CSS class used to render this tag.

Returns:

the color of this tag

toString

public String toString()

Overrides:

toString in class Object