ca.sqlpower.wabit.report.chart
Class ChartColumn

java.lang.Object
  ca.sqlpower.wabit.AbstractWabitObject
      ca.sqlpower.wabit.report.chart.ChartColumn

All Implemented Interfaces:

WabitObject

public class ChartColumn
extends AbstractWabitObject

This class handles some of the generic methods to the ColumnIdentifier. This will not store the specific object that makes the column be uniquely identified.

Nested Class Summary

static class

ChartColumn.DataType Enumeration of the data types a chart column can have.

Constructor Summary

ChartColumn(java.lang.String columnName, ChartColumn.DataType dataType)
Creates a new chart column descriptor for the given name simplified SQL data type.

ChartColumn(java.lang.String columnName, int jdbcType)
Creates a new chart column descriptor for the given name and JDBC data type.

Method Summary

boolean	allowsChildren() Returns true if this object may contain children.
int	childPositionOffset(java.lang.Class<? extends WabitObject> childType) Returns the position in the list that would be returned by getChildren() that the first object of type childClass is, or where it would be if there were any children of that type.
boolean	equals(java.lang.Object obj) Two identifiers for the same column name are considered equal.
java.util.List<? extends WabitObject>	getChildren() Returns an unmodifiable list of the children in this WabitObject.
java.lang.String	getColumnName()
ChartColumn.DataType	getDataType()
java.util.List<WabitObject>	getDependencies() Returns a list of all WabitObjects that this Wabit object is dependent on.
ColumnRole	getRoleInChart()
ChartColumn	getXAxisIdentifier()
int	hashCode()
protected boolean	removeChildImpl(WabitObject child) This is the object specific implementation of removeChild.
void	removeDependency(WabitObject dependency) Removes the given object as a dependency of this object.
void	setRoleInChart(ColumnRole dataType)
void	setXAxisIdentifier(ChartColumn xAxisIdentifier)
java.lang.String	toString()

Methods inherited from class ca.sqlpower.wabit.AbstractWabitObject

addChild, addChildImpl, addWabitListener, begin, beginTransaction, cleanup, commit, commitTransaction, fireChildAdded, fireChildRemoved, firePropertyChange, firePropertyChange, firePropertyChange, fireTransactionEnded, fireTransactionRollback, fireTransactionStarted, generateNewUUID, getChildren, getName, getParent, getSession, getUUID, isForegroundThread, removeChild, removeWabitListener, rollback, rollbackTransaction, runInBackground, runInForeground, setName, setParent, setUUID

Methods inherited from class java.lang.Object

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

Constructor Detail

ChartColumn

public ChartColumn(@Nonnull
                   java.lang.String columnName,
                   int jdbcType)

Creates a new chart column descriptor for the given name and JDBC data type.

Parameters:

columnName - The column's name (generally case sensitive)

jdbcType - The java.sql.Types type code.

ChartColumn

public ChartColumn(@Nonnull
                   java.lang.String columnName,
                   @Nonnull
                   ChartColumn.DataType dataType)

Creates a new chart column descriptor for the given name simplified SQL data type.

Parameters:

columnName - The column's name (generally case sensitive)

jdbcType - The java.sql.Types type code.

Method Detail

getRoleInChart

public ColumnRole getRoleInChart()

setRoleInChart

public void setRoleInChart(ColumnRole dataType)

getXAxisIdentifier

public ChartColumn getXAxisIdentifier()

setXAxisIdentifier

public void setXAxisIdentifier(ChartColumn xAxisIdentifier)

getDataType

public ChartColumn.DataType getDataType()

allowsChildren

public boolean allowsChildren()

Description copied from interface: WabitObject

Returns true if this object may contain children. Not all types of WabitObjects can be a child to any WabitObject.

See Also:

WabitObject.childPositionOffset(Class)

childPositionOffset

public int childPositionOffset(java.lang.Class<? extends WabitObject> childType)

Description copied from interface: WabitObject

Returns the position in the list that would be returned by getChildren() that the first object of type childClass is, or where it would be if there were any children of that type.

getChildren

public java.util.List<? extends WabitObject> getChildren()

Description copied from interface: WabitObject

Returns an unmodifiable list of the children in this WabitObject. If there are no children in this WabitObject an empty list should be returned.

getDependencies

public java.util.List<WabitObject> getDependencies()

Description copied from interface: WabitObject

Returns a list of all WabitObjects that this Wabit object is dependent on. Children of a WabitObject are not dependencies and will not be returned in this list. If there are no objects this Wabit object is dependent on an empty list should be returned. These are only the immediate dependencies of this object. If you want to find the dependencies of this object's dependencies as well it may be useful to look at WorkspaceGraphModel to make a full graph of all of the dependencies.

removeDependency

public void removeDependency(WabitObject dependency)

Description copied from interface: WabitObject

Removes the given object as a dependency of this object. For this object to no longer be dependent on the given dependency all of its children must also not be dependent on the given dependency when this method returns. This may remove this object from its parent if necessary.

getColumnName

public java.lang.String getColumnName()

equals

public boolean equals(java.lang.Object obj)

Two identifiers for the same column name are considered equal.

Overrides:

equals in class AbstractWabitObject

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class AbstractWabitObject

removeChildImpl

protected boolean removeChildImpl(WabitObject child)

Description copied from class: AbstractWabitObject

This is the object specific implementation of removeChild. There are checks in the removeChild method to ensure the child being removed has no dependencies and is a child of this object.

Specified by:

removeChildImpl in class AbstractWabitObject

See Also:

AbstractWabitObject.removeChild(WabitObject)