org.compiere.model
Class MColumn

java.lang.Object
  org.compiere.framework.PO
      org.compiere.model.X_AD_Column
          org.compiere.model.MColumn

All Implemented Interfaces:

Serializable, Cloneable, Comparator<PO>, Evaluatee

public class MColumn
extends X_AD_Column

Persistent Column Model

Version:

$Id: MColumn.java,v 1.6 2006/08/09 05:23:49 jjanke Exp $

Author:

Jorg Janke

See Also:

Serialized Form

Field Summary

Fields inherited from class org.compiere.model.X_AD_Column

accessLevel, AD_REFERENCE_ID_AD_Reference_ID, AD_REFERENCE_VALUE_ID_AD_Reference_ID, CONSTRAINTTYPE_AD_Reference_ID, CONSTRAINTTYPE_Cascade, CONSTRAINTTYPE_CascadeTrigger, CONSTRAINTTYPE_DoNOTCreate, CONSTRAINTTYPE_Null, CONSTRAINTTYPE_NullTrigger, CONSTRAINTTYPE_Restrict, CONSTRAINTTYPE_RestrictTrigger, ENTITYTYPE_AD_Reference_ID, ISENCRYPTED_AD_Reference_ID, ISENCRYPTED_Encrypted, ISENCRYPTED_NotEncrypted, Model, Table_ID, Table_Name, updatedMS

Fields inherited from class org.compiere.framework.PO

ACCESSLEVEL_ALL, ACCESSLEVEL_CLIENT, ACCESSLEVEL_CLIENTORG, ACCESSLEVEL_ORG, ACCESSLEVEL_SYSTEM, ACCESSLEVEL_SYSTEMCLIENT, ENTITYTYPE_Dictionary, ENTITYTYPE_UserMaintained, I_ZERO, log, p_changeVO, p_info, XML_ATTRIBUTE_AD_Table_ID, XML_ATTRIBUTE_Record_ID

Constructor Summary

MColumn(Ctx ctx, int AD_Column_ID, String trxName)
Standard Constructor

MColumn(Ctx ctx, ResultSet rs, String trxName)
Load Constructor

MColumn(MTable parent)
Parent Constructor

Method Summary

protected boolean	afterSave(boolean newRecord, boolean success) After Save
protected boolean	beforeSave(boolean newRecord) Before Save
static MColumn	get(Ctx ctx, int AD_Column_ID) Get M_Column from Cache
static String	getColumnName(Ctx ctx, int AD_Column_ID) Get Column Name
M_Element	getElement() Get Element
String	getFKColumnName() Get FK Name
MTable	getFKTable() Get FK Table - also for lists
String	getName(String AD_Language) Get Label Name
String	getSQLAdd(MTable table) Get SQL Add command
String	getSQLDataType() Get SQL Data Type
String	getSQLDDL() Get SQL DDL
String	getSQLDefaultValue() Get SQL Default Value
String	getSQLModify(MTable table, boolean setNullOption) Get SQL Modify command
boolean	isEncrypted() Is the Column Encrypted?
boolean	isFK() Column has FK (lists not included)
boolean	isList() Column is a List
boolean	isSelectionColumn() Selection Column
boolean	isStandardColumn() Is Standard Column
boolean	isVirtualColumn() Is Virtual Column
void	setIsEncrypted(boolean IsEncrypted) Set Encrypted
String	toString() String Representation

Methods inherited from class org.compiere.model.X_AD_Column

get_AccessLevel, getAD_Column_ID, getAD_Element_ID, getAD_Process_ID, getAD_Reference_ID, getAD_Reference_Value_ID, getAD_Table_ID, getAD_Val_Rule_ID, getCallout, getColumnName, getColumnSQL, getConstraintName, getConstraintType, getDefaultValue, getDescription, getEntityType, getFieldLength, getHelp, getIsEncrypted, getIsSyncDatabase, getKeyNamePair, getMandatoryLogic, getName, getReadOnlyLogic, getSelectionSeqNo, getSeqNo, getSummarySeqNo, getTableUID, getValueMax, getValueMin, getVersion, getVFormat, initPO, isAlwaysUpdateable, isCallout, isConstraintTypeValid, isIdentifier, isIsEncryptedValid, isKey, isMandatory, isMandatoryUI, isParent, isRecursiveFK, isSummaryColumn, isTranslated, isUpdateable, setAD_Column_ID, setAD_Element_ID, setAD_Process_ID, setAD_Reference_ID, setAD_Reference_Value_ID, setAD_Table_ID, setAD_Val_Rule_ID, setCallout, setColumnName, setColumnSQL, setConstraintName, setConstraintType, setDefaultValue, setDescription, setEntityType, setFieldLength, setHelp, setIsAlwaysUpdateable, setIsCallout, setIsEncrypted, setIsIdentifier, setIsKey, setIsMandatory, setIsMandatoryUI, setIsParent, setIsRecursiveFK, setIsSelectionColumn, setIsSummaryColumn, setIsSyncDatabase, setIsTranslated, setIsUpdateable, setMandatoryLogic, setName, setReadOnlyLogic, setSelectionSeqNo, setSeqNo, setSummarySeqNo, setTableUID, setValueMax, setValueMin, setVersion, setVFormat

Methods inherited from class org.compiere.framework.PO

addAttachment, addAttachment, addError, afterDelete, beforeDelete, compare, convertToBigDecimal, convertToBoolean, convertToInt, convertToTimestamp, copy, copyValues, copyValues, createAttachment, delete_Accounting, delete, delete, dump, dump, equals, get_ChangeVO, get_ColumnCount, get_ColumnDescription, get_ColumnDisplayType, get_ColumnIndex, get_ColumnLabel, get_ColumnLookup, get_ColumnName, get_DisplayValue, get_EntityType, get_HashMap, get_ID, get_IDOld, get_Info, get_KeyColumns, get_Logger, get_Table_ID, get_Table_ID, get_TableName, get_Translation, get_TrxName, get_Value, get_Value, get_ValueAsInt, get_ValueAsInt, get_ValueAsString, get_ValueDifference, get_ValueDifference, get_ValueOfColumn, get_ValueOld, get_ValueOld, get_ValueOldAsInt, get_ValuesAsString, get_WhereClause, get_xmlDocument, get_xmlString, get_xmlString, getAD_Client_ID, getAD_Org_ID, getAllIDs, getAttachment, getAttachment, getAttachmentData, getCreated, getCreatedBy, getCtx, getFindParameter, getPdfAttachment, getUpdated, getUpdatedBy, getVO, hashCode, insert_Accounting, is_Changed, is_KeyColumn, is_new, is_ValueChanged, is_ValueChanged, isActive, isAttachment, isColumnMandatory, isColumnUpdateable, isMandatoryOK, isPdfAttachment, load, load, load, load, loadComplete, loadDefaults, loadSpecial, lock, save, save, saveNew_getID, saveNewInsertSQL, saveNewSpecial, saveUpdate, set_ChangeVO, set_ColumnUpdateable, set_CustomColumn, set_TrxName, set_Value, set_Value, set_ValueE, set_ValueNoCheck, set_ValueNoCheckE, set_ValueOfColumn, set_ValueString, setAD_Client_ID, setAD_Org_ID, setClientOrg, setClientOrg, setContext, setCtx, setDocWorkflowMgr, setIsActive, setStandardDefaults, setUpdateable, setUpdatedBy, toStringX, unlock, update

Methods inherited from class java.lang.Object

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

Constructor Detail

MColumn

public MColumn(Ctx ctx,
               int AD_Column_ID,
               String trxName)

Standard Constructor

Parameters:

ctx - context

AD_Column_ID -

trxName - transaction

MColumn

public MColumn(Ctx ctx,
               ResultSet rs,
               String trxName)

Load Constructor

Parameters:

ctx - context

rs - result set

trxName - transaction

MColumn

public MColumn(MTable parent)

Parent Constructor

Parameters:

parent - table

Method Detail

get

public static MColumn get(Ctx ctx,
                          int AD_Column_ID)

Get M_Column from Cache

Parameters:

ctx - context

AD_Column_ID - id

Returns:

M_Column

getColumnName

public static String getColumnName(Ctx ctx,
                                   int AD_Column_ID)

Get Column Name

Parameters:

ctx - context

AD_Column_ID - id

Returns:

Column Name or null

isStandardColumn

public boolean isStandardColumn()

Is Standard Column

Returns:

true for AD_Client_ID, etc.

isVirtualColumn

public boolean isVirtualColumn()

Is Virtual Column

Returns:

true if virtual column

isEncrypted

public boolean isEncrypted()

Is the Column Encrypted?

Returns:

true if encrypted

setIsEncrypted

public void setIsEncrypted(boolean IsEncrypted)

Set Encrypted

Parameters:

IsEncrypted - encrypted

getElement

public M_Element getElement()

Get Element

Returns:

element

beforeSave

protected boolean beforeSave(boolean newRecord)

Before Save

Overrides:

beforeSave in class PO

Parameters:

newRecord - new

Returns:

true

afterSave

protected boolean afterSave(boolean newRecord,
                            boolean success)

After Save

Overrides:

afterSave in class PO

Parameters:

newRecord - new

success - success

Returns:

success

getSQLAdd

public String getSQLAdd(MTable table)

Get SQL Add command

Parameters:

table - table

Returns:

sql

getSQLDDL

public String getSQLDDL()

Get SQL DDL

Returns:

columnName datataype .. or null if virtual column

getSQLModify

public String getSQLModify(MTable table,
                           boolean setNullOption)

Get SQL Modify command

Parameters:

table - table

setNullOption - generate null / not null statement

Returns:

sql separated by ;

getSQLDefaultValue

public String getSQLDefaultValue()

Get SQL Default Value

Returns:

default clause or ""

getSQLDataType

public String getSQLDataType()

Get SQL Data Type

Returns:

e.g. NVARCHAR2(60)

getName

public String getName(String AD_Language)

Get Label Name

Parameters:

AD_Language - language

Returns:

name

isFK

public boolean isFK()

Column has FK (lists not included)

Returns:

true if has FK

isList

public boolean isList()

Column is a List

Returns:

true if volumn is a list

getFKColumnName

public String getFKColumnName()

Get FK Name

Returns:

foreign key column name

getFKTable

public MTable getFKTable()

Get FK Table - also for lists

Returns:

FK Table

isSelectionColumn

public boolean isSelectionColumn()

Selection Column

Overrides:

isSelectionColumn in class X_AD_Column

Returns:

true if Selection Column

toString

public String toString()

String Representation

Overrides:

toString in class X_AD_Column

Returns:

info