com.elegantj.data.dataviewer
Class GroupBand

java.lang.Object
  com.elegantj.data.dataviewer.GroupBand

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable

public class GroupBand

extends java.lang.Object

implements java.io.Externalizable

The GroupBand provides the properties of the group band for data viewer.

See Also:

Serialized Form

Constructor Summary

GroupBand()

GroupBand(java.lang.String columns)

GroupBand(java.lang.String columns, java.lang.String sorting)

GroupBand(java.lang.String columns, java.lang.String sorting, java.lang.String ordering)

GroupBand(java.lang.String columns, java.lang.String sorting, java.lang.String ordering, boolean pageBreak, boolean resetPageNo)
Creates a GroupBand with specified column names for grouping and sorting with its sorting order represented in the form of comma separated string.

GroupBand(java.util.Vector groupColumns)

GroupBand(java.util.Vector groupColumns, java.util.Vector sortColumns)

GroupBand(java.util.Vector groupColumns, java.util.Vector sortColumns, boolean pageBreak, boolean resetPageNo)
Creates a GroupBand with specified column names for grouping and sorting with its sorting order represented in the form of vector.

Method Summary

java.lang.Object	clone() Returns the clone of the caller object
boolean	equals(java.lang.Object obj) Compares the specified Object with this GroupBand for equality.
java.util.Vector	getGroupColumns() Gets the column names for grouping
java.lang.String	getGroupLabel() Returns the identifier of the group
java.util.Vector	getSortColumnNames() Returns the vector containing only the column names for sorting
java.util.Vector	getSortColumns() Gets the column names for sorting
boolean	isAscendingSort(int columnIndex) Determines the sort column at the specified index has the ascending sort
boolean	isAscendingSort(java.lang.String columnName) Determines the specified sort column has the ascending sort
boolean	isNewPageOnGroupBreak() Determines whether the new page is created when group is changed
boolean	isResetPageNoOnGroupBreak() Determines whether the page no is reset when group is changed
void	readExternal(java.io.ObjectInput in)
void	setGroupColumns(java.util.Vector groupColumns) Sets the column names for grouping
void	setNewPageOnGroupBreak(boolean b) Determines whether the new page is created when group is changed
void	setResetPageNoOnGroupBreak(boolean b) Determines whether the page no is reset when group is changed
void	setSortColumns(java.util.Vector sortColumns) Sets the column names for sorting
static java.util.Vector	stringToVector(java.lang.String str) Converts the comma separated string into the vector
java.lang.String	toString() Converts the object to a string
static java.lang.String	vectorToString(java.util.Vector vector) Converts the vector into comma separated string
void	writeExternal(java.io.ObjectOutput out) Externalizable interface implementation to save and retrieve the state of this object

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GroupBand

public GroupBand()

GroupBand

public GroupBand(java.lang.String columns)

GroupBand

public GroupBand(java.lang.String columns,
                 java.lang.String sorting)

GroupBand

public GroupBand(java.lang.String columns,
                 java.lang.String sorting,
                 java.lang.String ordering)

GroupBand

public GroupBand(java.lang.String columns,
                 java.lang.String sorting,
                 java.lang.String ordering,
                 boolean pageBreak,
                 boolean resetPageNo)

Creates a GroupBand with specified column names for grouping and sorting with its sorting order represented in the form of comma separated string.

Parameters:

columns - the column names for grouping, default null

sorting - the column names for sorting, default null

ordering - the sorting order for the associated sort column names, default null

pageBreak - true if new page is created when group is changed

resetPageNo - true if new page is created when group is changed

GroupBand

public GroupBand(java.util.Vector groupColumns)

GroupBand

public GroupBand(java.util.Vector groupColumns,
                 java.util.Vector sortColumns)

GroupBand

public GroupBand(java.util.Vector groupColumns,
                 java.util.Vector sortColumns,
                 boolean pageBreak,
                 boolean resetPageNo)

Creates a GroupBand with specified column names for grouping and sorting with its sorting order represented in the form of vector.

Parameters:

groupColumns - the vector containing the column names for grouping, default null

sortColumns - the vector containing the column names for sorting with its sorting order , default null

pageBreak - true if new page is created when group is changed

resetPageNo - true if new page is created when group is changed

Method Detail

getGroupLabel

public java.lang.String getGroupLabel()

Returns the identifier of the group

Returns:

the string identifier of the group

setGroupColumns

public void setGroupColumns(java.util.Vector groupColumns)

Sets the column names for grouping

Parameters:

groupColumns - the vector containing the column names for grouping

getGroupColumns

public java.util.Vector getGroupColumns()

Gets the column names for grouping

Returns:

the vector containing the column names for grouping

setSortColumns

public void setSortColumns(java.util.Vector sortColumns)

Sets the column names for sorting

Parameters:

sortColumns - the vector containing the column names for sorting with its sorting order

getSortColumns

public java.util.Vector getSortColumns()

Gets the column names for sorting

Returns:

the two dimension vector containing the column names for sorting with its sorting order

getSortColumnNames

public java.util.Vector getSortColumnNames()

Returns the vector containing only the column names for sorting

Returns:

the vector containing the column names for sorting

isAscendingSort

public boolean isAscendingSort(java.lang.String columnName)

Determines the specified sort column has the ascending sort

Parameters:

columnName - the sort column name

Returns:

true if the column has the ascending sort, otherwise false

isAscendingSort

public boolean isAscendingSort(int columnIndex)

Determines the sort column at the specified index has the ascending sort

Parameters:

columnIndex - the sort column index

Returns:

true if the column has the ascending sort, otherwise false

setNewPageOnGroupBreak

public void setNewPageOnGroupBreak(boolean b)

Determines whether the new page is created when group is changed

Parameters:

b - true if new page is creates when group is changed

isNewPageOnGroupBreak

public boolean isNewPageOnGroupBreak()

Determines whether the new page is created when group is changed

Returns:

true if new page is creates when group is changed, otherwise false

setResetPageNoOnGroupBreak

public void setResetPageNoOnGroupBreak(boolean b)

Determines whether the page no is reset when group is changed

Parameters:

b - true if page no is reset when group is changed

isResetPageNoOnGroupBreak

public boolean isResetPageNoOnGroupBreak()

Determines whether the page no is reset when group is changed

Returns:

true if page no is reset when group is changed, otherwise false

stringToVector

public static java.util.Vector stringToVector(java.lang.String str)

Converts the comma separated string into the vector

Parameters:

str - the comma separated string

Returns:

the vector containing the elements, separated by comma in the string

vectorToString

public static java.lang.String vectorToString(java.util.Vector vector)

Converts the vector into comma separated string

Parameters:

vector - the vector

Returns:

the string having the comma separated vector elements

clone

public java.lang.Object clone()

Returns the clone of the caller object

equals

public boolean equals(java.lang.Object obj)

Compares the specified Object with this GroupBand for equality. Returns true if and only if the specified Object is also a GroupBand, both GroupBands have the same properties.

Parameters:

obj - the Object to be compared for equality with this GroupBand.

Returns:

true if the specified Object is equal to this GroupBand

toString

public java.lang.String toString()

Converts the object to a string

Returns:

a string representation of this class object

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Externalizable interface implementation to save and retrieve the state of this object

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException