com.asakusafw.vocabulary.attribute

Class ViewInfo

java.lang.Object

com.asakusafw.vocabulary.attribute.ViewInfo

All Implemented Interfaces:

Attribute, FlowElementAttribute

public final class ViewInfo
extends Object
implements Attribute

Represents information of data-flow views.

Since:

0.9.1

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ViewInfo.Direction Represents a kind of ordering direction.
static class	ViewInfo.Ordering Represents an ordering atom.
static class	ViewInfo.ViewKind Represents a kind of view.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static ViewInfo	flat() Returns an instance of flat view information.
List<String>	getGrouping() Returns the grouping properties.
ViewInfo.ViewKind	getKind() Returns the view kind.
List<ViewInfo.Ordering>	getOrdering() Returns the sort expression in each group.
List<String>	getTerms() Returns the property terms.
static ViewInfo	groupOf(String... terms) Creates a new group view information instance from the given grouping term list.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.asakusafw.vocabulary.attribute.Attribute

getDeclaringClass

Method Detail

flat

public static ViewInfo flat()

Returns an instance of flat view information.

Returns:

the instance

groupOf

public static ViewInfo groupOf(String... terms)

Creates a new group view information instance from the given grouping term list. Each term must start with either = (grouping), + (ascendant order), or - (descendant order), and follow its property name.

Parameters:

terms - the property terms

Returns:

the created instance

See Also:

getTerms()

getKind

public ViewInfo.ViewKind getKind()

Returns the view kind.

Returns:

the view kind

getTerms

public List<String> getTerms()

Returns the property terms. Each term must start with either = (grouping), + (ascendant order), or - (descendant order), and follow its property name.

Returns:

the property terms

See Also:

groupOf(String...)

getGrouping

public List<String> getGrouping()

Returns the grouping properties.

Returns:

the grouping properties

getOrdering

public List<ViewInfo.Ordering> getOrdering()

Returns the sort expression in each group.

Returns:

the sort expression

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object