|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.sf.dc.core.objects.DcObject
Base class for all Data Crow objects. Here the fields, values and required fields are stored. Checks are done to garantee uniqueness and validity of the items. Objects which extend this class need to override the save and load methods
Field Summary | |
static int |
_ID
|
protected java.util.Collection |
alChildren
|
protected java.util.ArrayList |
alValues
|
protected static boolean |
alwaysGenerateID
|
protected boolean |
bValidation
Indicates of the data should be checked for validity |
protected int |
module
|
protected int |
uiRowNumber
|
protected static WorkFlow |
wf
|
Constructor Summary | |
protected |
DcObject()
Creates an empty data crow object |
Method Summary | |
void |
addChild(DcObject child)
Adds a child to this object |
void |
addChildren(java.util.Collection children)
|
void |
addRequest(IRequest request)
Add a requestor. |
void |
applySettings(DcFieldDefinitions definitions)
Initialize all user settings on this data crow object |
void |
checkIntegrity(boolean update)
Checks if the values are unique and if all the required fields have been filled |
void |
clearValues()
Sets all values to empty |
void |
delete()
|
java.lang.String[] |
getChangedFields()
Returns the labels of the fields that have been marked as changed |
java.lang.Object[] |
getChangedValues()
Returns the values of the fields that have been marked as changed |
java.util.Collection |
getChildren()
Retrieve all children of this object |
java.lang.String[] |
getCreateStatements()
Returns the create statement for the table for this object |
java.lang.String |
getDatabaseFieldName(int index)
Returns the database field name for the given field |
java.lang.String[] |
getDatabaseFieldNames()
Returns all the database field names |
int[] |
getDisabledFields()
Retrieves all disabled fields |
java.lang.String |
getDisplayString(int index)
|
DcField |
getField(int index)
Returns the field definition object for the given field index |
int[] |
getFieldIndices()
Returns all field indices |
DcField[] |
getFields()
Returns all the field definitions. |
int |
getFieldType(int index)
Returns the UI field type for the given field |
int[] |
getFieldTypes()
Returns all the UI field types |
abstract java.lang.String |
getFilename()
Returns the filename |
int[] |
getHiddenFields()
Retrieves all currently, to the user, hidden fields |
abstract javax.swing.ImageIcon |
getIcon()
Returns the icon for this object. |
java.lang.String |
getID()
Retrieves the ID for this data crow object |
java.lang.String |
getLabel(int index)
Retrieves the label for the given field |
java.lang.String[] |
getLabels()
Retrieves all field labels |
int |
getMaxFieldLength(int index)
Retrieves the maximum length for the given field |
int[] |
getMaxFieldLengths()
Retrieves the maximum length(s) for all the fields |
DCModule |
getModule()
Returns the module to which this object belongs. |
int[] |
getNotSearchableFields()
Retrieves all fields on which a search cannot be performed. |
int |
getParentReferenceFieldIndex()
Retrieve the field index holding the reference to the parent (the primary key of the parent) |
int[] |
getReadOnlyFields()
Returns the fields that are uneditable to the user |
RequestCollection |
getRequests()
Returns all requestors |
int[] |
getRequiredFields()
Returns the required field names |
int |
getRow()
|
boolean |
getSilence()
Indicates if queries should display output |
java.lang.String |
getTableJoin()
|
java.lang.String |
getTableName()
|
java.lang.String |
getTableShortName()
|
java.lang.String |
getUnfilledRequiredFields()
Checks to see whether al required fields have been filled |
java.lang.Object |
getValue(int index)
Returns the value of a field |
java.lang.Object[] |
getValues()
|
int[] |
getVisibleFields()
Retrieves the indices of the, for the user visible fields |
java.lang.Object[] |
getVisibleValues()
Retrieves the values for the visible fields |
boolean |
isBatch()
Part of a batch ? |
boolean |
isChanged()
Indicates if changes have been made to this data crow object. |
boolean |
isChanged(int index)
Indicates if changes have been made to the specified value. |
boolean |
isEnabled(int index)
Indicates if the given field is visible to the user or not |
boolean |
isEndOfBatch()
End of the batch ? |
boolean |
isRequired(int index)
Indicates whether the given field is required or not |
boolean |
isSearchable(int index)
Indicates whether the given field is required or not |
void |
isUnique(DcObject o,
boolean bUpdateQuery)
Checks to see whether the item already exists or not |
void |
load(QueryOptions options)
Loads items. |
void |
removeChildren()
Remove all children from this object |
void |
removeRequestors()
Remove all requestors listening in on this object |
void |
saveNew()
Inserts a new item. |
void |
saveUpdate()
Updates an item. |
static void |
setAlwaysGenerateID(boolean alwaysGenerateID)
Deprecated. |
void |
setBatch(boolean batch)
Indicates this object being part of a larger operation |
void |
setChanged(int index,
boolean b)
Marks the specified value as changed (or not) This means that the value will be considered for an insert or update to the database |
void |
setChildren(java.util.Collection children)
|
void |
setEndOfBatch(boolean end)
Indicates this object to be the last in row of an update / insert or delete |
void |
setIDs()
Apply the IDs on this object and its children |
protected abstract void |
setModuleIndex()
Sets the module index / sets the ownership of this data crow object |
void |
setRow(int row)
|
void |
setSilence(boolean silence)
Disables the output of this query to the log and log screen. |
void |
setValidation(boolean validate)
Specifies if values should be validated |
void |
setValue(int index,
java.lang.Object value)
Sets a value for the given field |
void |
setValues(java.lang.Object[] row)
Sets a complete set of values on the object calls setValue for each individual value |
QueryCondition |
toQueryCondition(boolean select)
Creates a query condition for select statements by using the field names and their values |
void |
undoChanges()
Sets all fields to 'unchanged'. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected int uiRowNumber
protected int module
protected java.util.ArrayList alValues
protected boolean bValidation
protected static boolean alwaysGenerateID
protected static final WorkFlow wf
protected java.util.Collection alChildren
public static final int _ID
Constructor Detail |
protected DcObject()
Method Detail |
public void removeRequestors()
public RequestCollection getRequests()
public java.lang.String getTableName()
public java.lang.String getTableShortName()
public java.lang.String getTableJoin()
public void addRequest(IRequest request)
public void setEndOfBatch(boolean end)
end
- public void setBatch(boolean batch)
batch
- part of batch y/npublic boolean isBatch()
public boolean isEndOfBatch()
public void removeChildren()
public void setChildren(java.util.Collection children)
public void addChildren(java.util.Collection children)
public void addChild(DcObject child)
child
- public java.util.Collection getChildren()
public int getParentReferenceFieldIndex()
public void setValues(java.lang.Object[] row)
setValue(int, Object)
public abstract javax.swing.ImageIcon getIcon()
public abstract java.lang.String getFilename()
public DCModule getModule()
public DcField[] getFields()
public void undoChanges()
public boolean isChanged()
public boolean isChanged(int index)
index
- the value index to check onpublic void setChanged(int index, boolean b)
index
- the value index to mark as changed / unchangedb
- changed y/npublic boolean isEnabled(int index)
index
- field indexpublic boolean isRequired(int index)
index
- field indexpublic boolean isSearchable(int index)
index
- field indexpublic int[] getDisabledFields()
public int[] getHiddenFields()
public java.lang.String getID()
public int[] getNotSearchableFields()
public int[] getVisibleFields()
public java.lang.Object[] getVisibleValues()
public static void setAlwaysGenerateID(boolean alwaysGenerateID)
alwaysGenerateID
- public void setValue(int index, java.lang.Object value)
public void clearValues()
public java.lang.String[] getLabels()
public java.lang.String getLabel(int index)
index
- field indexpublic int[] getMaxFieldLengths()
public int getMaxFieldLength(int index)
index
- field indexpublic java.lang.Object getValue(int index)
public java.lang.String getDisplayString(int index)
public java.lang.Object[] getValues()
public void setRow(int row)
public int getRow()
public int[] getFieldTypes()
ComponentFactory
public int getFieldType(int index)
ComponentFactory
public java.lang.String[] getDatabaseFieldNames()
public java.lang.String getDatabaseFieldName(int index)
index
- field indexpublic int[] getRequiredFields()
public int[] getReadOnlyFields()
public void saveNew() throws ValidationException
ValidationException
public void saveUpdate() throws ValidationException
ValidationException
public void delete()
public void load(QueryOptions options)
options
- query options, can be nullpublic void setSilence(boolean silence)
silence
- show output y/npublic boolean getSilence()
public void setValidation(boolean validate)
validate
- validate values y/npublic QueryCondition toQueryCondition(boolean select)
select
- indicates if this is about a select querypublic DcField getField(int index)
index
- field indexpublic java.lang.String[] getChangedFields()
public java.lang.Object[] getChangedValues()
public void checkIntegrity(boolean update) throws ValidationException
update
- indicates if the values are new or existing
ValidationException
public java.lang.String[] getCreateStatements()
public void isUnique(DcObject o, boolean bUpdateQuery) throws ValidationException
o
- object to be checkedbUpdateQuery
- indicates whether the object is to
be updated or if it is a new object
ValidationException
public java.lang.String getUnfilledRequiredFields()
public int[] getFieldIndices()
protected abstract void setModuleIndex()
public void applySettings(DcFieldDefinitions definitions)
public void setIDs()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |