Interface DataColumn

An interface to represent a data column.

Implementation note: Will be backed up by a column in an SQL table.

Synopsis

 public interface DataColumn {
  public Class getType();
  public boolean isRequiredForUpdate();
  public String getName();
  public DataScheme getAssociatedDataScheme();
  public String getNameInAssociatedDataScheme();
  public String getChoices();
}

Inheritance Path. org.kaiwitte.workbench.data.DataColumn

getAssociatedDataScheme()

Synopsis: public DataScheme getAssociatedDataScheme();

Parameters

return

the associated org.kaiwitte.workbench.data.DataScheme or null if there is none.

Returns the associated org.kaiwitte.workbench.data.DataScheme or null if there is none. The latter is the general case.

Example: This column represents a customer id, and it is part of a org.kaiwitte.workbench.data.DataScheme that represents repair orders. Then this method returns an otherorg.kaiwitte.workbench.data.DataScheme which represents a customer.

getName()

Synopsis: public String getName();

Parameters

return

the name of this column

Returns the name of this column.

getNameInAssociatedDataScheme()

Synopsis: public String getNameInAssociatedDataScheme();

Parameters

return

the name in the associated org.kaiwitte.workbench.data.DataScheme; null iff getAssociatedDataScheme() returns null.

Returns the name in the associated org.kaiwitte.workbench.data.DataScheme.

Example: customerid

getType()

Synopsis: public Class getType();

Parameters

return

the Java type of the column.

Returns the Java type of the column.

isRequiredForUpdate()

Synopsis: public boolean isRequiredForUpdate();

Parameters

return

wether or not this column is required to perform an update.

Returns true iff updates can only be performed when this column is specified.