com.aspc.DBObj

Class DBObject

java.lang.Object

com.aspc.DBObj.DBObject

All Implemented Interfaces:

SecondaryCacheGroup

Direct Known Subclasses:

AccessControl, AccessControlClause, AccessControlSanityCheck, AccessControlSanityCheckCase, AccessControlSanityCheckCaseGroup, AccessGroup, Account, AccountClassification, AccountJournal, AccountJournalSet, AccountType, Address, Agreement, Answer, AnswerChoice, Answers, AnswersCallAttempt, AnswersStatus, ApprovalStatus, ArchiveClass, ArticleChannel, ArticleChannelMap, ArticlePermissionMap, ArticleTemplate, ArtworkFile, Award, AwardMap, BankAccount, BankAccountType, BatchNumber, Bid, BigIN, BlogExperienceMap, BpayBatch, BpayBatchNumber, BpayTransaction, BranchCommittee, BranchMeeting, BranchOrganiser, BranchPosition, Bsb, BuildingSize, BuildingType, CacheParent, CacheParent2, CacheParentTemplate, CampaignResource, CampaignResultConfig, CampaignStatus, Car, CascadingStyleSheet, CascadingStyleSheetMap, CascadingStyleSheetVariable, CassandraClass, ChargeItem, ChargeItemPriceAdjReason, CheckBoxHelper, CheckBoxLinkedHelper, ClassA, ClassB, Code, Committee, CommunicationControl, ComponentMenu, ComponentMenuItem, Conference, ConferenceMember, ConferenceMemberPayment, ConferenceMemberWorkshop, ConferenceName, ConferenceWorkshop, ConstantHolder, Contact, ContactAddressType, ContactCategoryAction, ContactMap, ContactMultiUpdate, ContactProduct, ContactRelationshipAttMap, ContactRelationshipAttType, ContactRelationshipType, Contract, Country, CountryCurrencyMap, Course, CPModule, CPModuleControl, CPNewObject, CreditCardType, CreditEftposProcessingState, CreditEftposProcessingType, CriteriaSearchFieldMap, CustomActionClass, CustomGuestPreValClass, CustomizedReportType, CustomSecurityClass, DailyBankDepositListingType, DataAccessLog, DBAction, DBActionType, DBAlert, DBAlertActionExcludePersonGroup, DBAlertActionRecipient, DBAlertAssocPath, DBAlertLevel, DBAlertType, DBClassAbstract, DBClassModule, DBClassSyncCondition, DBClassSyncConditionField, DBClassSyncMap, DBCluster, DBCommand, DBCurrency, DBCustomCriteria, DBDashboard, DBEmail, DBEmailAccount, DBEmailAccountSecurity, DBEmailAccountType, DBEmailAttachment, DBEmailAutoResponse, DBEmailAutoResponseStatus, DBEmailFolder, DBEmailMessageParser, DBEmailRecipient, DBEmailRecipientType, DBEmailSendFormat, DBEmailSendStatus, DBEmailTemplate, DBEmailTemplateVariable, DBEvent, DBEventCondition, DBEventConditionField, DBEventPredecessorMap, DBEventPref, DBEventQueue, DBEventValidation, DBEventValidationGroup, DBEventValidationLevel, DBEventWorkflowMap, DBExclude, DBFailedLogin, DBFailedLoginCategory, DBField, DBFieldDelimiter, DBFieldSubClassAtt, DBFieldSubType, DBFileLocation, DBFileStore, DBFileStoreAlternate, DBFileStorePref, DBFileStoreVolume, DBFileTemplate, DBFolder, DBHelpItem, DBHelpItemCategory, DBHelpItemCategoryMap, DBImplements, DBImport, DBImportField, DBJasperReport, DBJasperReportParam, DBJasperReportVariable, DBJasperSubReport, DBJob, DBJobManagerSession, DBJobManagerSessionAttribute, DBJobManagerStatus, DBJobStatistic, DBJobStatisticHeader, DBJobStatisticMap, DBJobStatus, DBLanguage, DBLoadCache, DBLocation, DBLocationTimeZoneMap, DBLog, DBLogicalLock, DBLogicalLockGroup, DBLogicalLockType, DBMagicNumber, DBMagicNumberType, DBMessage, DBMessageCategory, DBMessageCategoryMap, DBMessageType, DBMessageVariable, DBMessageVariableType, DBModule, DBModuleMode, DBModuleOption, DBModuleProxy, DBMonthOfYear, DBNotification, DBPasswordStorage, DBPermission, DBPermissionType, DBPref, DBPrefGroup, DBPrinter, DBPrinterTray, DBPrintJasperReport, DBPrintType, DBQueue, DBQueueFilter, DBQueueProperty, DBRelease, DBReleaseClass, DBRemoteFileStore, DBRemoteFileStoreVolume, DBRepeatFrequency, DBRepeatRange, DBRepeatRule, DBRepeatRuleEndType, DBRepeatRuleExclude, DBRepeatRuleFreqSubType, DBRepeatRuleOccurrence, DBRepeatRuleWeekDay, DBReport, DBReportClause, DBReportCriteria, DBReportOrClause, DBReportType, DBSection, DBSectionVariable, DBServer, DBSkins, DBSms, DBSmsProvider, DBSmsRecipient, DBSmsSendStatus, DBSortOrder, DBStatsSection, DBStoredResult, DBStoredResultMode, DBStoredResultPersistentMode, DBSysPrefs, DBSystemProperty, DBSystemPropertyCriteria, DBSystemPropertyCriteriaType, DBSystemPropertyMap, DBSystemPropertyMatch, DBTask, DBTaskMonitorLevel, DBTaskStatus, DBTaskType, DBTimeZone, DBTransactionMsg, DBTransactionMsgFld, DBTriStateOption, DBUserAction, DBVolume, DBWeekDay, DBWorkflow, DBWorkflowMutexGroup, DeductionBatch, DeductionList, DeductionMember, DeductionMemberCategory, Delivery, DeliverySchedule, DerivedFieldCls, DerivedFieldCls, DerivedFieldCls, DirectDebitStatus, DirectDebitSystem, DirtyObj, DistributionMethod, DistributionMethodType, DistributionStatus, Document, DocumentType, DupObject, Edition, EditionFile, EditionFileFormat, EditionFileStatus, EditionRecipient, EditionStatus, EmailDistributionRecipient, EmailFileAttachmentOption, EmailMapping, EmailTo, Employee, EnquirySubType, EnquiryType, Entitlement, EntitlementMap, ExampleTemplate, ExemptionReason, ExpectedTaskBilling, ExternalDataSource, ExternalDataSourceType, ExternalMode, ExtValidator, Globals, Grade, GWTModule, GWTScreenCssMap, HistoryAudit, HistoryAuditMsg, IndustrialInstrumentFiles, InventoryAdjustmentItemType, Invoice, InvoicePayment, InvoicePaymentBreakDown, InvoiceRefund, InvoiceRefundBreakdown, InvoiceRefundMethod, InvoiceRefundReason, JobTaskType, KnowledgeAnswer, KnowledgeAnswerDepends, KnowledgeClaim, KnowledgeExpertise, KnowledgeFilterType, KnowledgeMap, KnowledgeQuestion, KnowledgeQuestionCheck, KnowledgeQuestionCheckType, KnowledgeQuestionMatch, KnowledgeQuestionMode, KnowledgeReplace, KnowledgeResponseMode, KnowledgeSubGroup, KnowledgeTag, KnowledgeTagCategory, KnowledgeThesaurus, KnowledgeTopic, LabelColumn, LinkedClass, ListenerClass, LoadClass, Location, Login, LogMsgPatternMask, ManagerType, MatrixChart, MatrixChartDataMap, MatrixChartTimeRange, MatrixData, MatrixDataFilter, MatrixSourceServer, MatrixType, MatrixTypeAttribute, MatrixTypeCategory, Member, MemberClass, MemberCommittee, MemberDeclinedGraduateReason, MemberExchange, MemberFinancialStatus, MemberRecruiterType, MemberRenewalTable, MemberRenewalType, MembershipCategory, MembershipCategoryGroup, MembershipConfig, MembershipCreditEftposProcessing, MembershipRates, MembershipRatesNewYearCreation, MembershipReverseCreditEftposBatch, MemberSource, MemberStatus, MemberTrack, MemberType, MemberTypeGroup, MenuItem, MetricChart, MetricChartFolder, MetricChartSource, MetricSource, MetricSourceGroupMap, MonitorMemberCommands, NoJmsObject, Note, NoteCategory, NoteCategoryMap, NoticeSchedule, NoticeSend, NotificationLoginMap, NotificationType, ObsoleteMatrixChart, ObsoleteMatrixSource, Occupation, OnlineAccountType, OnlineRequest, OnlineRequestInterest, OnlineRequestInterestMap, OnlineRequestOption, OnlineRequestOptionMap, OnlineRequestProduct, OnlineRequestType, Other, OutsourceMemberCard, OutsourceRenewal, Page, PageAlias, Part, PaymentCreator, PaymentDetails, PaymentFrequency, PaymentGatewayService, PaymentMethod, PaymentMethodCategory, PaymentSource, PayPalInfo, PermissionedContactMap, Person, PersonGroupType, PersonLeave, PersonSkill, Polluter, PreValidator, PriceMatrix, PriceMatrixRateCategory, ProcessTransactionMap, ProductAttributes, ProductBuildLine, ProductCategoryMap, ProductComponent, ProductDeliveryCorrection, ProductFulfillment, ProductImageMap, ProductLabour, ProductOffer, ProductOption, ProductOptionType, ProductPartBreakDown, ProductPartOrder, ProductRelationsMap, ProviderPriceMatrix, Publication, PublicationRecipient, PublicationTemplate, PublicComment, PublicHoliday, Purchase, PurchasePayment, PurchasePaymentBreakDown, Question, QuestionChoice, QuestionChoiceAlign, QuestionFilter, QuestionFilterType, Questionnaire, QuestionType, QUnitTest, QuoteKeywords, QuoteTemplate, RawPriceMatrix, RecruitVisit, Region, RenewalTerm, RestDefinition, RestDefinitionExternalDocs, RestDefinitionLifeCycle, RestDefinitionMonthlyUsage, RestDefinitionSanity, RestDefinitionSanityItem, RestDefinitionTag, RestDefinitionTransform, RestDefinitionVariable, RestDefinitionVariableLocation, RestDefinitionVariableSanity, RestDefinitionVariableType, RestMockResponse, RetainerEmailRecipient, ReverseEmployerRemittance, ReverseMemberPayment, RollbackObject, RootClass, Royalty, SalaryCategory, SalaryCategoryLabel, SalePromotionCode, SaveEventObject, ScriptLink, ScriptMode, SDBButtonMode, SDBComponent, SDBComponentNoteCntrl, SDBGWTModule, SDBGWTModuleMap, SDBHorizontalAlign, SDBIFrameScrollingOption, SDBInternalScreenGroups, SDBLogAssocPath, SDBLogControl, SDBLogControlField, SDBLogFilterType, SDBMenuItem, SDBPageHeadComponent, SDBPopupMenuBarOrientation, SDBRadioBtnAlign, SDBReportGridControl, SDBReportGroupBy, SDBSearchComponentType, SDBStyleControl, SDBTextBtn, SDBTextBtnPlugin, SDBTextToolBar, SDBTextToolbarBtn, SDBTextToolBarBtnMap, SDBTextToolBarMap, SDBTextToolbarRow, SDBToolbarPosition, SDBVerticalAlign, SDBViewControl, SDBViewControlMode, Sector, SecureVault, SecurityCheck, Session, SessionAction, SessionActionStatus, SessionActionType, SessionType, SettleCredit, SettleCreditBreakdown, ShippingRule, ShippingRuleVariant, ShippingSanityCheck, ShippingSanityCheckProductMap, ShoppingCart, ShoppingCartItem, ShoppingCartItemOption, ShortenURL, SiteActiveHTMLParser, SiteComponent, SiteComponentAttribute, SiteComponentVariableMap, SiteComponentVisibility, SiteConfigurationVarGroup, SiteConfigurationVarType, SiteConfigurationVarValues, SiteContainerType, SiteFeedParser, SiteFramework, SiteMapChangeFrequency, SitePageStatus, SitePermissionMap, SiteResource, SiteResourceMap, SiteResourceType, SiteScriptDependency, SiteScriptModule, SiteScriptVersion, SiteSpider, SiteSpiderConfig, SiteStatus, SiteTemplate, SiteVariable, SiteVariableEncoding, Skill, SkillLevel, SkillPriceMatrix, SkillPriceMatrixIssues, SkillPriceMatrixTermType, SkillSet, SlowDerived, SlowObj, SlowSaveObj, SMEGCap, SMEGPurchaseOrder, SortByField, SpecialPriceMatrix, SqlVariableRunAs, StateRegion, STCompany, STContact, STContact, StockBin, StockBinAdjustment, StockBinItem, StockReceipt, StockReceiptItem, StoreCheckoutSoapMessage, StoryCapMap, StorySectorMap, STSub, SubContinuationMethod, SubscriptionDefaultItemType, SubscriptionIssuesAlloc, SubscriptionItemType, SubscriptionTerm, Suburb, SupplierQuoteNew, TagLinks, Tags, TangibilityJob, TangibilityJobStatus, TangibilityProductOption, TangibilityProductOption, Task, TaskCategory, TaskCategoryMap, TaskContact, TaskEmailMap, TaskJobMap, TaskNotifyContactMap, TaskPredecessorMap, TaskResource, TaskResult, TaskSimpleStatus, TaskStatusChangeWorkflow, TaskStatusJournal, TaskTemplateType, TaskTypeModuleControl, Team, TestInstantiation.ATemplate, TestInstantiation.MainClass, TextFieldHelper, TimeEntry, TimeSheet, TransCommentHelper, TransferDeductionPayment, Tweet, TwitterAuthorisedTemplate, TwitterResponseStatus, TwitterScan, TwitterUser, TwitterUserAccount, TwitterUserList, Venue, WaitForMe, WebAppManifestDisplay, WebAppManifestIcon, WebAppManifestOrientation, WebOnlineOrder, WhiteListEmail, WorkflowStatus, WorkplaceAward, WorkplaceLabelMemberType, WorkplaceMemberTransfer, WorkplaceReps, WorkplaceVisit, WriteClass, XeroApp, XeroAppScopeMap, XeroScope, XPath

@ParametersAreNonnullByDefault
public class DBObject
extends java.lang.Object
implements SecondaryCacheGroup

DBObject is an instance of a DBClass. Extend this class to add functionality to stSoftware
The class represents a single row in the database. Each datasource will generate a new instance of a DBObject which holds the specific state of this record for a datasource.

MIXED MODE THREADING: When a DBObject is comes from a mutable data source or archive data source the DBObject is in SINGLE THREADED mode and is NOT shared. When the DBObject is retrieved via a VirtualDB (Read only data source) the DBObject is in MULTI-THREADED mode and is shared.

TODO: Create a "SingleThreadDBObject" interface to mark a DBObject as only being able to be accessed in single thread mode.

Extending a DBObject

What When Why ? Events eventDataLoaded() When the underlying database record is changed ( Always Multi-threaded) Clear secondary cache items. eventFieldUpdated() When a field value is changed via a setXXXX method this method will be called. Create composite keys based on the new field values. Update other fields when a field changes. Eg. If a person's title is set to 'Mr' we could set the person's gender to be 'Male' Touch() other objects that you wish to include in the universe validation. extAutoEnterCreate() When a new DBObject is created by calling create( className) method of a MutableDataSource, Extend this method to add auto entered values. If the values to be entered are "simple" values ('Mr', 'Entered' etc) or one of the predefined calculated ( Created By Person, Created time etc) then these maybe selected in the DBField web administration screen extDelete() When a record is marked for deletion by calling the delete() method of DBObect. We could also delete other associated records and thus avoid foreign key restrictions We could set a status on a parent record. Listeners eventDependantAdded() When the DBObject implements a DependanceListener and a dependent record is added Clear secondary cache items. eventDependantRemoved() When the DBObject implements a DependanceListener and a dependent record is removed Clear secondary cache items. Gets and Sets methods extGetDerivedGlobalKey() When a getXXXX method is called for a derived linked field To return a dynamically calculated linked field. extGetDerivedValue() When a getXXXX method is called for a derived non linked field To return a dynamically calculated field value. extGetValue() When a getXXXX method is called for any field Blank out a password or sensitive field. Make sure that the value returned is the "SAME" value as would normally be returned as the database searches used the final method getPureValue() and will return unexpected results if the value is altered. extSetValue() When a setXXXX method is called for any field Allow you to ignore a value set by any publicly available set methods Any internal setting of values should be done via the final method iSetValue Validation extValidationDelete() During the validation process for a record that is marked for deletion To add validations for records marked for deletion only extValidationField() For each field during the validation process for a new or modified record To add validations for a field extValidationRecord() During the validation process for a new or modified record To add validations for a record as a whole Saving extDeleteRecord() During the universe save process for a record marked for deletion, and within the database transaction Make changes to database tables that should be rolled back if the whole transaction doesn't succeed extPostDeleteRecord() When a record is deleted and after the database transaction has been completed Send a message to another system notifying that a record has been deleted extPostSaveRecord() When a record modified and after the database transaction has been completed Send a message to another system notifying that a record has been modified extPreDeleteRecord() When a record is marked for deletion and before the MutableDataSource's final call to validation universe and before a database transaction is started and batch save begins Set a status in a related record. extPreSaveRecord() When a record is new or modified and before the MutableDataSource's final call to validation universe and before a database transaction is started and batch save begins Set a status in a related record. extSaveRecord() During the universe save process for a new or modified record, and within the database transaction Make changes to database tables that should be rolled back if the whole transaction doesn't succeed Field name constants Always use the field name constants when possible Access Control and Result filters extCanDeleteDependantObject() During the validation process, each record marked for deletion will check that it can either delete any dependent objects or that it doesn't have any dependent objects. A dependent record maybe automatically deleted if the record is dependent via a link that has been marked as 'Parent Can Delete child and it has no children that can't be deleted via the same rules. Extend this method to alter this behaviour. extCheckCreateAccess() Called during the validation process of a new DBObject. The Standard ACL restrictions will be invoked before calling extCheckCreateAccess(). Add additional restrictions to the creation of DBObjects. Additional access restrictions here are similar to a normal validation error for NEW records only. This method can only add additional restrictions, it can not ignore ones generated via the ACL mechanism. extCheckDeleteAccess() Called during the validation process of deleted ( and not new) records. The Standard ACL restrictions will be invoked before calling extCheckDeleteAccess(). Add additional restrictions to the deletion of records. Additional access restrictions here are similar to a normal validation error for DELETED only records. This method can only add additional restrictions, it can not ignore ones generated via the ACL mechanism. extCheckModifyAccess() Called during the validation process of a modified records and for each field modified. The Standard ACL restrictions will be invoked before calling extCheckModifyAccess(). Add additional restrictions to the modification of records. Additional access restrictions here are similar to a normal validation error for MODIFIED records only. This method can only add additional restrictions, it can not ignore ones generated via the ACL mechanism. extCheckReadAccess() Called during the selection process. If you can't read a record you can't modify or delete it. The Standard ACL restrictions will be invoked before calling extCheckModifyAccess(). Add additional restrictions to filter the selection of records. This method can only add additional restrictions, it can not ignore ones generated via the ACL mechanism.

JSR 305 THREAD MODE: MIXED, SINGLE-THREADED when called from MutableDataSource else READONLY

Since:

July 1, 2000, 2:52 PM

Author:

Nigel Leck

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DBObject.DenormalizeAction De-normalize action

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTRIBUTE_MARVIN MARVIN mode
DBClass	dbClass the class of this object
DataSource	ds the datasource for this object
protected static FldParams	NO_LOOP_PARAMS don't loop

Constructor Summary

Constructors

Constructor and Description
DBObject(DBClass theClass, DataSource dataSource) Creates new DBObject.

Method Summary

Modifier and Type	Method and Description
void	addReloadEventListener(ReloadEventListener listener) Adds a object to be notified when this object is reloaded.
ValidationList	archiveCheck() check the archive version to the current version.
void	autoEnterCreate(FldParams params) Standard method for Populating the fields when the object is created.
java.lang.Object	calculateValue(DBField field, FldParams params) Calculate the field value.
java.lang.Object	calculateValue(java.lang.String name) Calls the primary getField
java.lang.Object	calculateValue(java.lang.String name, FldParams params) Calls the primary getField
boolean	callingRestoreByJournal() we are currently calling restore by journal
boolean	changeThreadMode(ThreadCop.MODE mode) change the thread mode for this object
void	checkCreateAccess() Checks the user has access to create an object.
void	checkDelete() Checks if this object may be deleted.
void	checkDeleteAccess() Checks the user has delete access to this object
void	checkModifyAccess() Check the user has MODIFY access to this object.
void	checkModifyAccess(DBField field) Checks the user has MODIFY access to this field of this object
void	checkReadAccess() Checks the users select access.
protected void	clearCache(GlobalKey changedKey) Automatically called for eventDataLoaded() with this GlobalKey and getCleanVersion() with null for the global key.
DBObject	copy(MutableDataSource mds) copy the object
void	copyFields(DBObject orig) Copies the fields from another DBObject into this one.
boolean	copyIncludeField(DBObject orig, DBField field) To filter the fields not to copy.
DBObject[]	copyInwardLinks(DBObject orig, DBField linkedField) Copies the objects pointing to this object.
void	delete() Mark this object for deletion ( when save is called for the mutable data source)
SoapResultSet	denormalizedResult(java.lang.String code) NO ACCESS CONTROL & SHARED RESULTS & CURRENT SAVED RESULTS ONLY
java.lang.String	displayLogName() The human readable object name in the logs.
java.lang.String	displayName() The display name
java.lang.String	displayValue() Displays the value of the default display field
DBResult	doSearch(java.lang.String thePath) A short hand method of getting a result set for a path from this object.
void	dump() DEBUG dump of the current object's fields values to std.
boolean	equals(java.lang.Object o) Please don't overload this method as it'll cause odd errors where internal messages will be lost.
protected void	eventDataLoaded() When the underlying DBData is changed/ loaded.
protected void	eventFieldUpdated(DBField field, java.lang.Object previous, GlobalKey previousKey, FldParams params) OVERRIDE This method to be notified when a field changes.
protected void	extAutoEnterCreate() Extend this method to add functionality when a new DBObject is created. You may need to create a FldParams, and setIsAutoEntered(true) so that system does not misunderstand that this object is changed by user.
protected boolean	extCanDeleteDependantObject(DBObject o) OVERRIDE This method to Alter the default behaviour of check if we can remove a dependent object.
protected void	extCheckCreateAccess() Additional access checking for create access of this object.
protected void	extCheckDeleteAccess() Additional access checking for delete access of this object.
protected void	extCheckModifyAccess() Additional access checking for write access of this object.
protected void	extCheckModifyAccess(DBField field) Additional access checking for write access for a field of this object.
protected void	extCheckReadAccess() Additional access checking for read access of this object.
protected void	extCopy(DBObject target) Additional functionality when an object is copied.
protected void	extDelete() Additional functionality when an object is marked for deletion by calling delete().
protected void	extDeleteRecord(long transNr) OVERRIDE this method to add functionality to stSoftware WHILE deleting the record from the database.
protected void	extFixUp() The extended fix up routine
protected GlobalKey	extGetDerivedGlobalKey(DBField field, FldParams params) OVERRIDE This method to return a derived global key.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) OVERRIDE This method for all objects with derived fields that are NOT linked.
protected java.lang.Object	extGetValue(DBField field, FldParams params) This is the PRIMARY "get" method which returns the processed field value for this object.
protected boolean	extIsMandatory(DBField field) OVERRIDE This method to specify fields should be mandatory under certain conditions.
protected boolean	extIsOnChange(DBField field) OVERRIDE This method to specify that when a field is updated it will affect other fields.
protected void	extMarkSavePoint(java.lang.String id) Mark the save point which we can rollback to later.
protected void	extPostDeleteRecord(long transNr) OVERRIDE this method to add functionality to stSoftware AFTER deleting the record from the database.
protected void	extPostSaveRecord(long transNr) OVERRIDE this method to add functionality to stSoftware AFTER saving the record to the database.
protected void	extPreDeleteRecord() OVERRIDE this method to add functionality to stSoftware BEFORE deleting a record from the database.
protected void	extPreSaveRecord() OVERRIDE this method to add functionality to stSoftware BEFORE saving the record to the database.
protected void	extPreValidate() OVERRIDE To add functionality to before validation is called.
protected void	extPreValidateDelete() OVERRIDE To add functionality to before validation is called.
protected void	extRaiseEvents() raise the events
protected void	extRollbackTo(java.lang.String id) Rollback to save point.
protected void	extSaveRecord(long transNr) OVERRIDE this method to add functionality to stSoftware WHILE saving the record to the database.
protected void	extSetValue(DBField field, java.lang.Object currentValue, FldParams params) OVERRIDE This method to filter ALL public calls to SetValue.
protected void	extUndelete() Additional functionality when an object is undeleted.
protected void	extValidateDelete(ValidationList list) Extend this method to add validation to a record then deleted.
protected ValidationError	extValidateField(DBField field, ValidationList list) Additional validation for particular field OVERRIDE THIS METHOD TO ADD VALIDATIONS FOR A FIELD.
protected void	extValidateRecord(ValidationList list) Performs additional validations on this record.
Holder	fetchLinkHolder(DBClass sourceClass, DBField sourceField) Returns the holder for a the inwards links.
GlobalKey	findGlobalKey(DBField field) Returns the GlobalKey for the linked object via the passed field name.
GlobalKey	findGlobalKey(DBField field, FldParams params) Returns the GlobalKey for the linked object via the passed field name.
GlobalKey	findGlobalKey(java.lang.String fieldName) Returns the GlobalKey for the linked object via the passed field name.
GlobalKey	findGlobalKey(java.lang.String fieldName, FldParams params) Returns the GlobalKey for the linked object via the passed field name.
DBObject	findLinkedObject(DBField field, FldParams params) Returns the linked object for the passed field
DBObject	findLinkedObject(java.lang.String fieldName) Returns the linked object for the passed field
DBObject	findLinkedObject(java.lang.String fieldName, FldParams params) Returns the linked object for the passed field
DBDataInterface	findRawData()
void	fireEventDataLoaded() INTERNAL USE ONLY This method is called when the underlying DBData is changed / loaded.
void	fixUp() calls the fix up routines for this object
long	forceLockedTransaction() Use the current transaction number when applying the changes to the database.
boolean	getBoolean(DBField field) Get Boolean
boolean	getBoolean(DBField field, boolean flag) Get Boolean
boolean	getBoolean(DBField field, FldParams params) The boolean value
boolean	getBoolean(java.lang.String name) Get Boolean
boolean	getBoolean(java.lang.String name, boolean flag) Get Boolean
boolean	getBoolean(java.lang.String name, FldParams params) The boolean value for a field
ChangedFieldData	getChangedFieldInfo(DBField field) Returns a non mutable changed field and corresponding values/keys.
ChangedFields	getChangedFields() Returns a list of non mutable changed fields and corresponding values/keys.
java.util.Date	getDate(DBField field) Get Date
java.util.Date	getDate(DBField field, java.util.Date defaultDate) Get Date
java.util.Date	getDate(java.lang.String name) Get Date
java.util.Date	getDate(java.lang.String name, java.util.Date theDate) Get Date
java.util.Date	getDate(java.lang.String name, FldParams params) Get Date
java.lang.Object	getDefaultValue(DBField field) Returns the default value for the field.
boolean	getDisableOnChangeEvent() Is on changed disabled
double	getDouble(DBField field) Get Double
double	getDouble(DBField field, double defaultValue) Get Double
double	getDouble(java.lang.String name) Get Double
double	getDouble(java.lang.String name, double defaultValue) Get Double
double	getDouble(java.lang.String field, FldParams params) Get Double
double	getFieldDouble(java.lang.String fieldName, java.lang.String... args)
int	getFieldInt(java.lang.String fieldName, java.lang.String... args)
long	getFieldLong(java.lang.String fieldName, java.lang.String... args)
java.lang.String	getFieldString(java.lang.String fieldName, java.lang.String... args)
java.lang.String	getFormattedString(DBField field, java.lang.String specificFormat, FldParams params) Returns the formatted value of the field.
java.lang.String	getFormattedString(java.lang.String name, java.lang.String specificFormat, FldParams params) Returns the formatted value of the field.
GlobalKey	getGlobalKey() Returns the GlobalKey for this DBObject.
GlobalKey	getGlobalKey(DBField field) Returns the GlobalKey for the linked object via the passed field name.
GlobalKey	getGlobalKey(DBField field, FldParams params) Returns the GlobalKey for the linked object via the passed field name.
GlobalKey	getGlobalKey(java.lang.String fieldName) Returns the GlobalKey for the linked object via the passed field name.
GlobalKey	getGlobalKey(java.lang.String fieldName, FldParams params) Returns the GlobalKey for the linked object via the passed field name.
int	getInt(DBField field) Get Int
int	getInt(DBField field, FldParams params) Get Int
int	getInt(DBField field, int defaultValue) Get Int
int	getInt(java.lang.String name) Get Int
int	getInt(java.lang.String name, FldParams params) Get Int
int	getInt(java.lang.String name, int defaultValue) Get Int
DBResult	getInwardLinkage(DBField sourceField, HintField hint) Get the cached DBResult set for the linkage passed.
java.lang.String	getKeyString() The string version of the key
java.lang.Object	getKeyValue() Returns the key value.
DBObject	getLinkedObject(DBField field, FldParams params) Returns the linked object for the passed field
DBObject	getLinkedObject(java.lang.String fieldName) Returns the linked object for the passed field
DBObject	getLinkedObject(java.lang.String fieldName, FldParams params) Returns the linked object for the passed field
DBObject	getLinkedObjectByKey(DBField field, FldParams params) get the linked object by key
long	getLinkedRowId(DBField field, FldParams params) Returns the row id of the linked object for the passed field
long	getLinkedRowId(java.lang.String fieldName, FldParams params) Returns the row id of the linked object for the passed field
long	getLinkedRowIdByData(DBField field, FldParams params) find the linked row id using the underlying raw data
Holder	getLinkHolder(DBClass sourceClass, DBField sourceField) Returns the holder for a the inwards links.
long	getLockedTransaction() The locked transaction number
long	getLong(DBField field) Get Long
long	getLong(DBField field, FldParams params) Get Long
long	getLong(DBField field, long defaultValue) Get Long
long	getLong(java.lang.String name) Get Long
long	getLong(java.lang.String name, FldParams params) Get Long
long	getLong(java.lang.String name, long defaultValue) Get Long
MutableArrayValue	getMutableArrayValue(DBField field) Get the mutable array value
MutableArrayValue	getMutableArrayValue(java.lang.String name) Get the mutable array value
GlobalKey	getOriginalKey(DBField field) Returns the original key for this field from the underlying DBData.
java.lang.Object	getOriginalValue(DBField field) Returns the original value for this field from the underlying DBData.
java.lang.Object	getOriginalValue(GlobalKey fieldKey) Returns the original value for this field from the underlying DBData.
java.lang.Object	getProcessedValue(DBField field, FldParams params)
java.lang.Object	getPureValue(DBField field, FldParams params) Returns the pure value for this field.
DBDataInterface	getRawData() INTERNAL USE ONLY
java.lang.Object	getRawValue(DBField field) Returns the raw value for this field from the underlying DBData or the updated fields.
java.lang.Object	getRawValue(GlobalKey fieldId) Returns the raw value for this field from the underlying DBData or the updated fields.
long	getRowId() Returns the unique global row id MutableDataSource uses a single thread model.
java.lang.Long	getRowKey() Return the row key ( Long)
java.lang.Object	getSecondaryCacheGroupKey()
int	getSrcLayerID() Returns the source layer of this object
java.lang.String	getString(DBField field) Get String
java.lang.String	getString(DBField field, FldParams params) Get String
java.lang.String	getString(DBField field, java.lang.String params) Get String
java.lang.String	getString(java.lang.String name) Get String
java.lang.String	getString(java.lang.String name, FldParams params) Get String
java.lang.String	getString(java.lang.String name, java.lang.String params) Get String
java.lang.Object	getValue(DBField field) calls the primary getValue
java.lang.Object	getValue(DBField field, FldParams params) Calls the extGetValue
java.lang.Object	getValue(java.lang.String name) Calls the primary getField
java.lang.Object	getValue(java.lang.String name, FldParams params) Calls the primary getField
boolean	hasAutoChanged(DBField field) Tests that the ONLY change that has been made is to set to the auto entered value.
boolean	hasAutoChanged(java.lang.String name) Tests whether the change to the field was an auto enter
boolean	hasChanged() Has this object changed since last save Are all fields are blank or the auto entered values ?
boolean	hasChangedByUser() Has the user changed this object since last save Are all fields are blank or the auto entered values ?
boolean	hasChangedByUserField(DBField field) Tests whether the user has changed the field for this object.
boolean	hasChangedByUserField(java.lang.String name) Tests whether the user has changed the field for this object.
boolean	hasFieldChanged(DBField field) Tests weather the field has been changed.
boolean	hasFieldChanged(java.lang.String name) Tests weather the field has been changed.
int	hashCode() Please don't overload this method as it'll cause odd errors where internal messages will be lost.
boolean	hasStoredResult(java.lang.String code) check if the DBObject has the stored result for the given code
void	iCheckDeleteAccess(DataSource realDS) Internal ONLY
void	iCheckModifyAccess(DataSource realDS) Internal ONLY
void	iCheckReadAccess(DataSource realDS) Checks the users select access.
java.util.HashMap<java.lang.String,java.lang.String>	iGetDenormalizedMap() INTERNAL ONLY
protected java.lang.Object	iGetRawValue(DBField field) An optimized version of getRawField.
void	iPlaceDenormalizedResult(java.lang.String code, java.lang.String data) INTERNAL ONLY
void	iPostSaveOrDeleteRecord(long transNr) INTERNAL USE ONLY Called by the Mutable Data Source after all objects have been saved and commited
void	iPreSaveOrDeleteRecord() INTERNAL USE ONLY Do Auto enter values when a record is about to be saved.
void	iPreValidate() Internal Only
void	iRaiseEvents() INTERNAL USE ONLY Add Events to the EventQueue which have conditions that match the current status of the Object.
void	iSaveOrDeleteRecord(long transNr) INTERNAL USE ONLY Called by the mutable data source to during the save process.
boolean	isBrokenLink(DBField field) Is this field a "broken" link ? Does the field in this object have a value but we can't find the object that it points to.
boolean	isBrokenLink(java.lang.String name) Is this field a "broken" link ? Does the field in this object have a value but we can't find the object that it points to.
boolean	isChanged() Has this object changed within this universe ?
boolean	isDataCacheKnownToBeDirty() is the data cache dirty
boolean	isDeleted() Is this object marked as deleted ?
boolean	isEmpty() Is this object empty.
protected void	iSetValue(DBField field, java.lang.Object userValue, FldParams params) If the currentValue is a DBObject it'll be converted to a GlobalKey
boolean	isForceReindex() Has re-index been called ?
boolean	isKeyWordField(DBField field) Is this a key word field.
boolean	isMandatory(DBField field) Is this field mandatory for this object ?
boolean	isNew() Is this object new
boolean	isNull(DBField field) Test if this field is null .
boolean	isNull(java.lang.String name) Test if this field is null .
boolean	isOnChange(DBField field) Does this field affect other fields when updated
boolean	isReindex() Is the DBObject marked for re-indexing only ?
void	iValidateRecord(ValidationList list, java.util.HashMap<GlobalKey,java.util.HashMap<java.lang.String,java.util.ArrayList<DBObject>>> possibleConflicts) INTERNAL USE ONLY Performs validations on this record.
long	lastTouched() When was this object last touched ?
static ArchiveDataLoader	makeArchiveDataLoader(VirtualDB layer, DBClass rootClass, TransHeader maxTransaction)
DBObject	makeClone(DataSource targetDS)
static DataLoader	makeDataLoader(VirtualDB layer, DBClass rootClass, long[] rowsToLoad)
org.w3c.dom.Document	makeDenormalizedDoc(DBStoredResult dbSR, java.util.Date archiveDate) get a de-normalized document.
java.util.List	makeLinkedArray(java.lang.String name, java.lang.String... args)
protected DBAccessException	makeModifyAccessException(DBCriteria criteria) Retrieves a reason why the object cannot be modified
static SearchPlan	makeSearchPlan(DBQuery<DBObject> query) Allows for specific attributes to be set for the queries
WriteProvider	makeWriteProvider() Allows for specific attributes to be set for the queries.
void	manualDenormalizeOnSave(DBObject.DenormalizeAction da) manually denormalize
void	markSavePoint(java.lang.String id) Mark the save point which we can rollback to later.
long	optLockedTransaction() If not previously called, use the current transaction when updating the database.
void	registerWatchedObject(DBObject obj) INTERNAL USE ONLY When a object is being watched by another object we store a hard link to the watched object from the watcher to prevent watch objects from being GCed.
void	reindex() This allows the indexes for a records to be fixed up TODO: Should check for dirty cache.
void	releaseDenormalized(java.lang.String code) NO ACCESS CONTROL & SHARED RESULTS & CURRENT SAVED RESULTS ONLY
void	removeReloadEventListener(ReloadEventListener listener) Adds a object to be notified when this object is reloaded.
void	restoreByJournal(TransRecord tr, boolean replayMode) restore by journal
void	rollbackTo(java.lang.String id) Rollback to save point.
void	setBoolean(DBField field, boolean flag) Update a boolean field by field
void	setBoolean(DBField field, boolean flag, FldParams params) Update a boolean field by field
void	setBoolean(java.lang.String name, boolean flag) Update a boolean field by field name.
void	setBoolean(java.lang.String name, boolean flag, FldParams params) Update a boolean field by field name
void	setDisableOnChangeEvent(boolean flag) Allows the on Change Event to be disabled.
void	setDouble(DBField field, double value) Update a double field by field
void	setDouble(java.lang.String name, double value) Update a double field by field name
void	setInt(DBField field, int value) Update a integer field
void	setInt(java.lang.String name, int value) Update a integer field by field name
void	setLong(DBField field, long value) Update a long field
void	setLong(java.lang.String name, long value) Update a long field by field name
void	setRawData(DBDataInterface data) INTERNAL USE ONLY When a DataSource initiates a DBObject the Raw Data is set for existing DBObjects
void	setValue(DBField field, double value) Update a double field by field
void	setValue(DBField field, int value) Update a integer field
void	setValue(DBField field, long value) Update a long field
void	setValue(DBField field, java.lang.Object currentValue) Update a field value by field.
void	setValue(DBField field, java.lang.Object currentValue, FldParams inParams) Update a field by field
void	setValue(java.lang.String name, double value) Update a double field by field name
void	setValue(java.lang.String name, int value) Update a integer field by field name
void	setValue(java.lang.String name, long value) Update a long field by field name
void	setValue(java.lang.String name, java.lang.Object value) Update a field by field name
void	setValue(java.lang.String name, java.lang.Object value, FldParams params) Update a field by field name
java.lang.String	toString() The description.
void	touch() Touch this object so that it'll be included when the mutableDataSource is saved.
void	undelete() undelete this object
ValidationItem	validateField(DBField field) Validate this field.
ValidationList	validateRecord() Performs additional validations on this record.
protected void	validateSubType(DBField field, java.lang.Object value) http://www.regular-expressions.info/email.html http://tools.ietf.org/html/rfc2822#section-3.4.1

Methods inherited from class java.lang.Object

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

Field Detail

ATTRIBUTE_MARVIN

public static final java.lang.String ATTRIBUTE_MARVIN

MARVIN mode

See Also:

Constant Field Values

dbClass

@Nonnull
public final DBClass dbClass

the class of this object

ds

@Nonnull
public final DataSource ds

the datasource for this object

NO_LOOP_PARAMS

protected static final FldParams NO_LOOP_PARAMS

don't loop

Constructor Detail

DBObject

public DBObject(@Nonnull
                DBClass theClass,
                @Nonnull
                DataSource dataSource)
         throws java.lang.Exception

Creates new DBObject.

Parameters:

theClass - The class of this object

dataSource - Your current data source

Throws:

java.lang.Exception - Failed to initiate the database object.

Method Detail

makeLinkedArray

public java.util.List makeLinkedArray(@Nonnull
                                      java.lang.String name,
                                      java.lang.String... args)

makeClone

@OverridingMethodsMustInvokeSuper
 @Nonnull
public DBObject makeClone(@Nonnull
                                                                      DataSource targetDS)

Parameters:

targetDS -

Returns:

the value

isKeyWordField

@CheckReturnValue
public boolean isKeyWordField(@Nonnull
                                                DBField field)

Is this a key word field. This allows the developer to add additional fields such as a derived field which displays a file or URL content. An additional derived field displaying the file content would allow the file to to be indexed but not the file itself to be loaded into the database.

Parameters:

field - the field to test

Returns:

true if a key word.

makeWriteProvider

@CheckReturnValue
 @Nonnull
public WriteProvider makeWriteProvider()

Allows for specific attributes to be set for the queries.

Returns:

The search plan

makeDataLoader

@CheckReturnValue
 @Nonnull
public static DataLoader makeDataLoader(VirtualDB layer,
                                                                    DBClass rootClass,
                                                                    long[] rowsToLoad)
                                                             throws java.lang.Exception

Parameters:

layer - the layer

rootClass - the root class

rowsToLoad - the rows to load

Returns:

the data result

Throws:

java.lang.Exception - a serious problem

makeArchiveDataLoader

@CheckReturnValue
public static ArchiveDataLoader makeArchiveDataLoader(VirtualDB layer,
                                                                        DBClass rootClass,
                                                                        TransHeader maxTransaction)
                                                                 throws java.lang.Exception

Parameters:

layer - the layer

rootClass - the root class

maxTransaction - the max transaction

Returns:

the archive data loader

Throws:

java.lang.Exception - a serious problem

getSecondaryCacheGroupKey

@CheckReturnValue
 @Nonnull
public java.lang.Object getSecondaryCacheGroupKey()

Specified by:

getSecondaryCacheGroupKey in interface SecondaryCacheGroup

Returns:

the group key

changeThreadMode

public boolean changeThreadMode(@Nonnull
                                ThreadCop.MODE mode)

change the thread mode for this object

Parameters:

mode - new mode

Returns:

always true just so you can call from assert

iGetDenormalizedMap

@CheckReturnValue
 @Nullable
public java.util.HashMap<java.lang.String,java.lang.String> iGetDenormalizedMap()

INTERNAL ONLY

Returns:

the map

iPlaceDenormalizedResult

public void iPlaceDenormalizedResult(@Nonnull
                                     java.lang.String code,
                                     @Nonnull
                                     java.lang.String data)

INTERNAL ONLY

Parameters:

code - the code

data - the data

makeDenormalizedDoc

@CheckReturnValue
 @Nullable
public org.w3c.dom.Document makeDenormalizedDoc(@Nonnull
                                                                             DBStoredResult dbSR,
                                                                             @Nullable
                                                                             java.util.Date archiveDate)
                                                                      throws java.lang.Exception

get a de-normalized document.

Parameters:

dbSR - the definition

archiveDate - the archive date

Returns:

the document

Throws:

java.lang.Exception - a serious problem.

manualDenormalizeOnSave

public void manualDenormalizeOnSave(@Nonnull
                                    DBObject.DenormalizeAction da)
                             throws java.lang.Exception

manually denormalize

Parameters:

da - the action

Throws:

java.lang.Exception - a serious problem

releaseDenormalized

public void releaseDenormalized(@Nonnull
                                java.lang.String code)
                         throws java.lang.Exception

NO ACCESS CONTROL & SHARED RESULTS & CURRENT SAVED RESULTS ONLY

Parameters:

code - a code

Throws:

java.lang.Exception - a serious problem.

denormalizedResult

@CheckReturnValue
 @Nonnull
public SoapResultSet denormalizedResult(@Nonnull
                                                                    java.lang.String code)
                                                             throws java.lang.Exception

NO ACCESS CONTROL & SHARED RESULTS & CURRENT SAVED RESULTS ONLY

Parameters:

code - the code

Returns:

the value

Throws:

java.lang.Exception - a serious problem.

hasStoredResult

@CheckReturnValue
public boolean hasStoredResult(@Nonnull
                                                 java.lang.String code)
                                          throws java.lang.Exception

check if the DBObject has the stored result for the given code

Parameters:

code - the code

Returns:

true for have stored result

Throws:

java.lang.Exception - a serious problem.

getLinkHolder

@CheckReturnValue
public Holder getLinkHolder(@Nonnull
                                              DBClass sourceClass,
                                              @Nonnull
                                              DBField sourceField)

Returns the holder for a the inwards links.

Thread Safe:

The Holder is always created first if it points to a null list it'll be loaded. When we clear a link we clear the base HashTable. So if a parallel thread is loading the list it will continue but not be referenced again.

Parameters:

sourceClass - the source class ( required for fields in interfaces)

sourceField - The source field for the link

Returns:

The link holder.

fetchLinkHolder

@Nullable
public Holder fetchLinkHolder(@Nonnull
                                        DBClass sourceClass,
                                        @Nonnull
                                        DBField sourceField)

Returns the holder for a the inwards links. BUT DON'T create it if not there

Parameters:

sourceClass - the source class ( required for fields in interfaces)

sourceField - The source field for the link

Returns:

The link holder.

setBoolean

public final void setBoolean(@Nonnull
                             java.lang.String name,
                             boolean flag)
                      throws java.lang.Exception

Update a boolean field by field name.

Parameters:

flag - The boolean value to set

name - The name of the field to be updated

Throws:

java.lang.Exception - A serious problem, most validation is done later ( It's OK to be invalid here).

See Also:

extSetValue() To filter public setting of values

setBoolean

public final void setBoolean(@Nonnull
                             java.lang.String name,
                             boolean flag,
                             @Nullable
                             FldParams params)
                      throws java.lang.Exception

Update a boolean field by field name

Parameters:

params - the parameters

flag - The boolean value to set

name - The name of the field to be updated

Throws:

java.lang.Exception - A serious problem, most validation is done later ( It's OK to be invalid here).

See Also:

extSetValue() To filter public setting of values

setBoolean

public final void setBoolean(@Nonnull
                             DBField field,
                             boolean flag)
                      throws java.lang.Exception

Update a boolean field by field

Parameters:

flag - The boolean value to set.

field - The name of the field to be updated

Throws:

java.lang.Exception - A serious problem, most validation is done later ( It's OK to be invalid here).

See Also:

extSetValue() To filter public setting of values

setBoolean

public final void setBoolean(@Nonnull
                             DBField field,
                             boolean flag,
                             @Nullable
                             FldParams params)
                      throws java.lang.Exception

Update a boolean field by field

Parameters:

params - The parameters

flag - The boolean value to set.

field - The name of the field to be updated

Throws:

java.lang.Exception - A serious problem, most validation is done later ( It's OK to be invalid here).

See Also:

extSetValue() To filter public setting of values

setInt

public final void setInt(@Nonnull
                         java.lang.String name,
                         int value)
                  throws java.lang.Exception

Update a integer field by field name

Parameters:

name - The name of the field to be updated

value - The new value of the field

Throws:

java.lang.Exception - A serious problem, most validation is done later ( It's OK to be invalid here).

See Also:

extSetValue() To filter public setting of values

setInt

public final void setInt(@Nonnull
                         DBField field,
                         int value)
                  throws java.lang.Exception

Update a integer field

Parameters:

field - The name of the field to be updated

value - The new value of the field

Throws:

java.lang.Exception - A serious problem, most validation is done later ( It's OK to be invalid here).

See Also:

extSetValue() To filter public setting of values

setValue

public final void setValue(@Nonnull
                           java.lang.String name,
                           int value)
                    throws java.lang.Exception

Update a integer field by field name

Parameters:

name - The name of the field to be updated

value - The new value of the field

Throws:

java.lang.Exception - A serious problem, most validation is done later ( It's OK to be invalid here).

See Also:

extSetValue() To filter public setting of values

setValue

public final void setValue(@Nonnull
                           DBField field,
                           int value)
                    throws java.lang.Exception

Update a integer field

Parameters:

field - The name of the field to be updated

value - The new value of the field

Throws:

java.lang.Exception - A serious problem, most validation is done later ( It's OK to be invalid here).

See Also:

extSetValue() To filter public setting of values

setLong

public final void setLong(@Nonnull
                          java.lang.String name,
                          long value)
                   throws java.lang.Exception

Update a long field by field name

Parameters:

name - The name of the field to be updated

value - The new value of the field

Throws:

java.lang.Exception - A serious problem, most validation is done later ( It's OK to be invalid here).

See Also:

extSetValue() To filter public setting of values

setLong

public final void setLong(@Nonnull
                          DBField field,
                          long value)
                   throws java.lang.Exception

Update a long field

Parameters:

field - The field to be updated

value - The new value of the field

Throws:

java.lang.Exception - A serious problem, most validation is done later ( It's OK to be invalid here).

See Also:

extSetValue() To filter public setting of values

setValue

public final void setValue(@Nonnull
                           java.lang.String name,
                           long value)
                    throws java.lang.Exception

Update a long field by field name

Parameters:

name - The name of the field to be updated

value - The new value of the field

Throws:

java.lang.Exception - A serious problem, most validation is done later ( It's OK to be invalid here).

See Also:

extSetValue() To filter public setting of values

setValue

public final void setValue(@Nonnull
                           DBField field,
                           long value)
                    throws java.lang.Exception

Update a long field

Parameters:

field - The field to be updated

value - The new value of the field

Throws:

java.lang.Exception - A serious problem, most validation is done later ( It's OK to be invalid here).

See Also:

extSetValue() To filter public setting of values

setDouble

public final void setDouble(@Nonnull
                            java.lang.String name,
                            double value)
                     throws java.lang.Exception

Update a double field by field name

Parameters:

name - The name of the field to be updated

value - The new value of the field

Throws:

java.lang.Exception - A serious problem, most validation is done later ( It's OK to be invalid here).

See Also:

extSetValue() To filter public setting of values

setDouble

public final void setDouble(@Nonnull
                            DBField field,
                            double value)
                     throws java.lang.Exception

Update a double field by field

Parameters:

field - The field to be updated

value - The new value of the field

Throws:

java.lang.Exception - A serious problem, most validation is done later ( It's OK to be invalid here).

See Also:

extSetValue() To filter public setting of values

setValue

public final void setValue(@Nonnull
                           java.lang.String name,
                           double value)
                    throws java.lang.Exception

Update a double field by field name

Parameters:

name - The name of the field to be updated

value - The new value of the field

Throws:

java.lang.Exception - A serious problem, most validation is done later ( It's OK to be invalid here).

See Also:

extSetValue() To filter public setting of values

setValue

public final void setValue(@Nonnull
                           DBField field,
                           double value)
                    throws java.lang.Exception

Update a double field by field

Parameters:

field - The field to be updated

value - The new value of the field

Throws:

java.lang.Exception - A serious problem, most validation is done later ( It's OK to be invalid here).

See Also:

extSetValue() To filter public setting of values

setValue

public final void setValue(@Nonnull
                           java.lang.String name,
                           @Nullable
                           java.lang.Object value)
                    throws java.lang.Exception

Update a field by field name

Parameters:

name - The name of the field to be updated

value - The new value of the field

Throws:

java.lang.Exception - A serious problem, most validation is done later ( It's OK to be invalid here).

See Also:

extSetValue() To filter public setting of values

setValue

public final void setValue(@Nonnull
                           java.lang.String name,
                           @Nullable
                           java.lang.Object value,
                           @Nullable
                           FldParams params)
                    throws java.lang.Exception

Update a field by field name

Parameters:

params - The fld params

name - The name of the field

value - The new value of the Field

Throws:

java.lang.Exception - A serious problem, most validation is done later ( It's OK to be invalid here).

See Also:

extSetValue() To filter public setting of values

setValue

public final void setValue(@Nonnull
                           DBField field,
                           @Nullable
                           java.lang.Object currentValue)
                    throws java.lang.Exception

Update a field value by field.

Parameters:

field - The field to be updated.

currentValue - The new value for the field.

Throws:

java.lang.Exception - A serious problem, most validation is done later ( It's OK to be invalid here).

See Also:

extSetValue() To filter public setting of values

setValue

public final void setValue(@Nonnull
                           DBField field,
                           @Nullable
                           java.lang.Object currentValue,
                           @Nullable
                           FldParams inParams)
                    throws java.lang.Exception

Update a field by field

Parameters:

inParams - The parameters

field - The field to update.

currentValue - The new value of the field.

Throws:

java.lang.Exception - A serious problem, most validation is done later ( It's OK to be invalid here).

See Also:

extSetValue() To filter public setting of values

touch

public final void touch()
                 throws DBAccessException

Touch this object so that it'll be included when the mutableDataSource is saved.

Throws:

DBAccessException - You don't have write permission.

isBrokenLink

@CheckReturnValue
public final boolean isBrokenLink(@Nullable
                                                    java.lang.String name)

Is this field a "broken" link ? Does the field in this object have a value but we can't find the object that it points to.
Please this is different to just not being allowed to see the record that it is pointed to. As this is a fairly normal condition

Parameters:

name - The field to check for the broken link

Returns:

true if the link is broken

isBrokenLink

@CheckReturnValue
public final boolean isBrokenLink(@Nonnull
                                                    DBField field)

Is this field a "broken" link ? Does the field in this object have a value but we can't find the object that it points to.
Please this is different to just not being allowed to see the record that it is pointed to. As this is a fairly normal condition

Parameters:

field - The field to check for the broken link

Returns:

true if the link is broken

lastTouched

@CheckReturnValue
public final long lastTouched()

When was this object last touched ?

Returns:

The time in milli-seconds

fixUp

public final void fixUp()
                 throws java.lang.Exception

calls the fix up routines for this object

Throws:

java.lang.Exception - a serious problem

delete

public final void delete()
                  throws java.lang.Exception

Mark this object for deletion ( when save is called for the mutable data source)

Throws:

java.lang.Exception - A serious problem

undelete

public final void undelete()
                    throws java.lang.Exception

undelete this object

Throws:

java.lang.Exception - a serious problem

callingRestoreByJournal

@CheckReturnValue
public final boolean callingRestoreByJournal()

we are currently calling restore by journal

Returns:

true if currently calling

restoreByJournal

public final void restoreByJournal(@Nonnull
                                   TransRecord tr,
                                   boolean replayMode)
                            throws java.lang.Exception

restore by journal

Parameters:

tr - the transaction record

replayMode - the replay mode

Throws:

java.lang.Exception - a serious problem.

copy

public final DBObject copy(@Nonnull
                           MutableDataSource mds)
                    throws java.lang.Exception

copy the object

Parameters:

mds - the data source to create the object from

Returns:

The new object

Throws:

java.lang.Exception - A serious problem

reindex

public final void reindex()
                   throws java.lang.Exception

This allows the indexes for a records to be fixed up TODO: Should check for dirty cache.

Throws:

java.lang.Exception - Failed to re-index

isReindex

@CheckReturnValue
public final boolean isReindex()

Is the DBObject marked for re-indexing only ?

Returns:

TRUE if marked for re-index.

autoEnterCreate

public final void autoEnterCreate(@Nullable
                                  FldParams params)
                           throws java.lang.Exception

Standard method for Populating the fields when the object is created.

Parameters:

params - The parameters

Throws:

java.lang.Exception - Failed to auto enter value.

See Also:

extAutoEnterCreate for a Overridable method.

getKeyValue

@CheckReturnValue
 @Nullable
public final java.lang.Object getKeyValue()

Returns the key value. Once a record has been created this never changes.

Returns:

The key Value

getKeyString

@CheckReturnValue
 @Nonnull
public final java.lang.String getKeyString()

The string version of the key

Returns:

The string key

getRowId

@CheckReturnValue
public final long getRowId()

Returns the unique global row id MutableDataSource uses a single thread model. No need to synchronized

Returns:

The row id

getRowKey

@CheckReturnValue
 @Nonnull
public final java.lang.Long getRowKey()

Return the row key ( Long)

Returns:

The row key

getSrcLayerID

@CheckReturnValue
public int getSrcLayerID()

Returns the source layer of this object

Returns:

The source layer ( virtual DB)

getDefaultValue

@CheckReturnValue
 @Nullable
public final java.lang.Object getDefaultValue(@Nonnull
                                                                           DBField field)

Returns the default value for the field.

Parameters:

field - The field to check

Returns:

The default Value.

getInwardLinkage

@CheckReturnValue
 @Nonnull
public final DBResult getInwardLinkage(@Nonnull
                                                                   DBField sourceField,
                                                                   @Nullable
                                                                   HintField hint)
                                                            throws java.lang.Exception

Get the cached DBResult set for the linkage passed.
Job:personId -> Contact::Person

Passing the field "job:personId" to a person object will return all jobs for
that person.

Parameters:

hint - hint of other objects

sourceField - The field that is linked to this class.

Returns:

The list of DBObjects that point to this DBObject.

Throws:

java.lang.Exception - a serious problem

getLinkedObject

@CheckReturnValue
 @Nullable
public final DBObject getLinkedObject(@Nonnull
                                                                   java.lang.String fieldName)

Returns the linked object for the passed field

Parameters:

fieldName - The linked field name.

Returns:

The linked object

findLinkedObject

@CheckReturnValue
 @Nonnull
public final DBObject findLinkedObject(@Nonnull
                                                                   java.lang.String fieldName)
                                                            throws NotFoundException

Returns the linked object for the passed field

Parameters:

fieldName - The linked field name.

Returns:

The linked object

Throws:

NotFoundException - if the record is not found.

getLinkedObject

@CheckReturnValue
 @Nullable
public final DBObject getLinkedObject(@Nonnull
                                                                   java.lang.String fieldName,
                                                                   @Nullable
                                                                   FldParams params)

Returns the linked object for the passed field

Parameters:

params - The field parameters to use

fieldName - The linked field name.

Returns:

The linked object

findLinkedObject

@CheckReturnValue
 @Nonnull
public final DBObject findLinkedObject(@Nonnull
                                                                   java.lang.String fieldName,
                                                                   @Nullable
                                                                   FldParams params)
                                                            throws NotFoundException

Returns the linked object for the passed field

Parameters:

params - The field parameters to use

fieldName - The linked field name.

Returns:

The linked object

Throws:

NotFoundException - if the record is not found.

findLinkedObject

@CheckReturnValue
 @Nonnull
public final DBObject findLinkedObject(@Nonnull
                                                                   DBField field,
                                                                   @Nullable
                                                                   FldParams params)
                                                            throws NotFoundException

Returns the linked object for the passed field

Parameters:

params - The field parameters to use

field - The linked field

Returns:

The linked Object

Throws:

NotFoundException - if the record is not found.

getLinkedObject

@CheckReturnValue
 @Nullable
public final DBObject getLinkedObject(@Nonnull
                                                                   DBField field,
                                                                   @Nullable
                                                                   FldParams params)

Returns the linked object for the passed field

Parameters:

params - The field parameters to use

field - The linked field

Returns:

The linked Object

getLinkedObjectByKey

@CheckReturnValue
 @Nullable
public final DBObject getLinkedObjectByKey(@Nonnull
                                                                        DBField field,
                                                                        @Nullable
                                                                        FldParams params)

get the linked object by key

Parameters:

params - the field parameters to use

field - The linked field

Returns:

The linked object

getLinkedRowId

@CheckReturnValue
public final long getLinkedRowId(@Nonnull
                                                   java.lang.String fieldName,
                                                   @Nullable
                                                   FldParams params)

Returns the row id of the linked object for the passed field

Parameters:

params - the field parameters to use

fieldName - The linked field name.

Returns:

The row id of the linked object

getLinkedRowId

@CheckReturnValue
public final long getLinkedRowId(@Nonnull
                                                   DBField field,
                                                   @Nullable
                                                   FldParams params)

Returns the row id of the linked object for the passed field

Parameters:

params - the field parameters to use

field - The linked field

Returns:

The row id of the linked Object

getLinkedRowIdByData

@CheckReturnValue
public final long getLinkedRowIdByData(@Nonnull
                                                         DBField field,
                                                         @Nullable
                                                         FldParams params)

find the linked row id using the underlying raw data

Parameters:

params - the field parameters to use

field - The linked field

Returns:

the linked row id

doSearch

@Nonnull
public final DBResult doSearch(@Nonnull
                                        java.lang.String thePath)
                                 throws java.lang.Exception

A short hand method of getting a result set for a path from this object.

Parameters:

thePath - The search path

Returns:

The result set.

Throws:

java.lang.Exception - A problem with the search

getChangedFields

@CheckReturnValue
 @Nonnull
public final ChangedFields getChangedFields()

Returns a list of non mutable changed fields and corresponding values/keys.

Returns:

The list of fields that have been changed.

getChangedFieldInfo

@CheckReturnValue
 @Nullable
public final ChangedFieldData getChangedFieldInfo(@Nullable
                                                                               DBField field)

Returns a non mutable changed field and corresponding values/keys.

Parameters:

field - The field

Returns:

A ChangedFieldData object for the specified field

addReloadEventListener

public final void addReloadEventListener(@Nonnull
                                         ReloadEventListener listener)

Adds a object to be notified when this object is reloaded.

Parameters:

listener - The object to be notified.

removeReloadEventListener

public final void removeReloadEventListener(@Nonnull
                                            ReloadEventListener listener)

Adds a object to be notified when this object is reloaded.

Parameters:

listener - The object to be notified.

setDisableOnChangeEvent

public final void setDisableOnChangeEvent(boolean flag)

Allows the on Change Event to be disabled. An example of when to do this is when we copy an object. If the onChangeEvent wasn't disabled the copied object could be different due to auto entered values.

Parameters:

flag - on or off

getDisableOnChangeEvent

@CheckReturnValue
public final boolean getDisableOnChangeEvent()

Is on changed disabled

Returns:

is disabled

toString

@CheckReturnValue
 @Nonnull
public java.lang.String toString()

The description.

Overrides:

toString in class java.lang.Object

Returns:

The description

getGlobalKey

@CheckReturnValue
 @Nonnull
public final GlobalKey getGlobalKey()

Returns the GlobalKey for this DBObject.

THREAD SAFE Caching of global keys is easier than other things. A property of a key is it may not be changed once created, so only updating of the key field needs to be checked. Which may only be done in a MutableDataSource which is single threaded.

Returns:

The Global Key

findGlobalKey

@CheckReturnValue
 @Nonnull
public final GlobalKey findGlobalKey(@Nonnull
                                                                 java.lang.String fieldName)
                                                          throws NotFoundException

Returns the GlobalKey for the linked object via the passed field name.

Parameters:

fieldName - The name of the linked field.

Returns:

The global key of the linked object.

Throws:

NotFoundException - no global key

getGlobalKey

@CheckReturnValue
 @Nullable
public final GlobalKey getGlobalKey(@Nullable
                                                                 java.lang.String fieldName)

Returns the GlobalKey for the linked object via the passed field name.

Parameters:

fieldName - The name of the linked field.

Returns:

The global key of the linked object.

findGlobalKey

@CheckReturnValue
 @Nonnull
public final GlobalKey findGlobalKey(@Nonnull
                                                                 java.lang.String fieldName,
                                                                 @Nullable
                                                                 FldParams params)
                                                          throws NotFoundException

Returns the GlobalKey for the linked object via the passed field name.

Parameters:

params - The parameters for this request.

fieldName - The name of the linked field.

Returns:

The global key of the linked object.

Throws:

NotFoundException - no key found.

getGlobalKey

@CheckReturnValue
 @Nullable
public final GlobalKey getGlobalKey(@Nullable
                                                                 java.lang.String fieldName,
                                                                 @Nullable
                                                                 FldParams params)

Returns the GlobalKey for the linked object via the passed field name.

Parameters:

params - The parameters for this request.

fieldName - The name of the linked field.

Returns:

The global key of the linked object.

findGlobalKey

@CheckReturnValue
 @Nonnull
public final GlobalKey findGlobalKey(@Nonnull
                                                                 DBField field)
                                                          throws NotFoundException

Returns the GlobalKey for the linked object via the passed field name.

Parameters:

field - The name of the linked field.

Returns:

The global key of the linked object.

Throws:

NotFoundException - no key found.

getGlobalKey

@CheckReturnValue
 @Nullable
public final GlobalKey getGlobalKey(@Nullable
                                                                 DBField field)

Returns the GlobalKey for the linked object via the passed field name.

Parameters:

field - The linked field

Returns:

The GlobalKey of the linked object

findGlobalKey

@CheckReturnValue
 @Nonnull
public final GlobalKey findGlobalKey(@Nonnull
                                                                 DBField field,
                                                                 @Nullable
                                                                 FldParams params)
                                                          throws NotFoundException

Returns the GlobalKey for the linked object via the passed field name.

Parameters:

params - The parameters for this request.

field - The name of the linked field.

Returns:

The global key of the linked object.

Throws:

NotFoundException - no key found.

getGlobalKey

@CheckReturnValue
 @Nullable
public final GlobalKey getGlobalKey(@Nullable
                                                                 DBField field,
                                                                 @Nullable
                                                                 FldParams params)

Returns the GlobalKey for the linked object via the passed field name.

Parameters:

params - The parameters for this request.

field - The linked field

Returns:

The GlobalKey of the linked object

validateRecord

@CheckReturnValue
 @Nonnull
public final ValidationList validateRecord()
                                                                throws java.lang.Exception

Performs additional validations on this record. iValidateRecord performs the full list of validations. The returned vector is a list of validationItems which may be warnings or errors. OVERRIDE this method to add additional validations to a record.
The MutableDataSource is in READONLY mode at this stage.

Returns:

the list of errors and warnings.

Throws:

java.lang.Exception - A serious problem

archiveCheck

@CheckReturnValue
 @Nonnull
public final ValidationList archiveCheck()
                                                              throws java.lang.Exception

check the archive version to the current version.

Returns:

the list of errors and warnings.

Throws:

java.lang.Exception - A serious problem

validateField

@CheckReturnValue
 @Nullable
public final ValidationItem validateField(@Nonnull
                                                                       DBField field)
                                                                throws java.lang.Exception

Validate this field.

Parameters:

field - The field to be validated

Returns:

the error or warning.

Throws:

java.lang.Exception - a serious error

checkDelete

public final void checkDelete()
                       throws DBAccessException

Checks if this object may be deleted. Foreign key restrictions.

Throws:

DBAccessException - You may not delete

checkReadAccess

public final void checkReadAccess()
                           throws DBAccessException

Checks the users select access.

Throws:

DBAccessException - If the user has no select access

iCheckReadAccess

public final void iCheckReadAccess(@Nonnull
                                   DataSource realDS)
                            throws DBAccessException

Checks the users select access. This method provides greater performance then checkReadAccess() in the case where we already have the object from virtual db and the login from mutable data source as is the case for MutableDataSource.recycleObject

Parameters:

realDS - the real data source

Throws:

DBAccessException - If the user has no select access

checkModifyAccess

public final void checkModifyAccess(@Nonnull
                                    DBField field)
                             throws DBAccessException

Checks the user has MODIFY access to this field of this object

Parameters:

field - The field to check

Throws:

DBAccessException - No access

See Also:

extCheckModifyAccess to add additional conditions.

checkModifyAccess

public final void checkModifyAccess()
                             throws DBAccessException

Check the user has MODIFY access to this object.

Throws:

DBAccessException - No access

See Also:

extCheckModifyAccess to add additional conditions.

iCheckModifyAccess

public final void iCheckModifyAccess(@Nonnull
                                     DataSource realDS)
                              throws DBAccessException

Internal ONLY

Parameters:

realDS - the real data source

Throws:

DBAccessException - no access

checkDeleteAccess

public final void checkDeleteAccess()
                             throws DBAccessException

Checks the user has delete access to this object

Throws:

DBAccessException - No Access

See Also:

extCheckDeleteAccess to add additional conditions.

iCheckDeleteAccess

public final void iCheckDeleteAccess(@Nonnull
                                     DataSource realDS)
                              throws DBAccessException

Internal ONLY

Parameters:

realDS - the real data source

Throws:

DBAccessException - no user access

checkCreateAccess

public final void checkCreateAccess()
                             throws DBAccessException

Checks the user has access to create an object. TODO: this seems odd place for it.

Throws:

DBAccessException - No Access

makeModifyAccessException

@CheckReturnValue
 @Nonnull
protected DBAccessException makeModifyAccessException(@Nonnull
                                                                                  DBCriteria criteria)

Retrieves a reason why the object cannot be modified

Parameters:

criteria - the criteria to check

Returns:

the access exception

isDataCacheKnownToBeDirty

@CheckReturnValue
public final boolean isDataCacheKnownToBeDirty()

is the data cache dirty

Returns:

true if the data is know as dirty

isDeleted

@CheckReturnValue
public final boolean isDeleted()

Is this object marked as deleted ?

Returns:

True if deleted.

isMandatory

@CheckReturnValue
public final boolean isMandatory(@Nonnull
                                                   DBField field)

Is this field mandatory for this object ?

Parameters:

field - The field

Returns:

True if deleted.

isOnChange

@CheckReturnValue
public final boolean isOnChange(@Nonnull
                                                  DBField field)

Does this field affect other fields when updated

Parameters:

field - The field

Returns:

True if it affects other fields.

isChanged

@CheckReturnValue
public final boolean isChanged()

Has this object changed within this universe ?

Returns:

True if changed.

isNull

@CheckReturnValue
public final boolean isNull(@Nonnull
                                              java.lang.String name)

Test if this field is null .

Special cases: No UI way of setting some field types back to null.
Blank string and text fields are treated as null.
Boolean fields that is false is also treated as null.

Parameters:

name - The name of the field

Returns:

true if the field is null

isNull

@CheckReturnValue
public final boolean isNull(@Nonnull
                                              DBField field)

Test if this field is null .

Special cases: No UI way of setting some field types back to null.
Blank string and text fields are treated as null.
Boolean fields that is false is also treated as null.

Parameters:

field - The field to check

Returns:

true if null

isEmpty

@CheckReturnValue
public final boolean isEmpty()

Is this object empty.

Are all fields are blank or the auto entered values ?

Returns:

True if empty

hasChanged

@CheckReturnValue
public final boolean hasChanged()

Has this object changed since last save

Are all fields are blank or the auto entered values ?

Returns:

True if changed

hasChangedByUser

@CheckReturnValue
public final boolean hasChangedByUser()

Has the user changed this object since last save

Are all fields are blank or the auto entered values ?

Returns:

True if changed

hasFieldChanged

@CheckReturnValue
public final boolean hasFieldChanged(@Nonnull
                                                       java.lang.String name)

Tests weather the field has been changed.

Parameters:

name - The name of the field

Returns:

True if the field has changed.

hasFieldChanged

@CheckReturnValue
public final boolean hasFieldChanged(@Nonnull
                                                       DBField field)

Tests weather the field has been changed.

Parameters:

field - The field to check

Returns:

True if the field has changed.

hasChangedByUserField

@CheckReturnValue
public final boolean hasChangedByUserField(@Nonnull
                                                             java.lang.String name)

Tests whether the user has changed the field for this object.

Parameters:

name - The name of the field

Returns:

True if the field has changed.

hasChangedByUserField

@CheckReturnValue
public final boolean hasChangedByUserField(@Nonnull
                                                             DBField field)

Tests whether the user has changed the field for this object.

Parameters:

field - The field to check

Returns:

True if the field has changed.

hasAutoChanged

@CheckReturnValue
public final boolean hasAutoChanged(@Nonnull
                                                      java.lang.String name)

Tests whether the change to the field was an auto enter

Parameters:

name - The name of the field

Returns:

True if the field has changed.

hasAutoChanged

@CheckReturnValue
public final boolean hasAutoChanged(@Nonnull
                                                      DBField field)

Tests that the ONLY change that has been made is to set to the auto entered value.

Parameters:

field - The field to check

Returns:

True if the field has changed TO the auto entered value.

isNew

@CheckReturnValue
public final boolean isNew()

Is this object new

Returns:

true if new

isForceReindex

@CheckReturnValue
public final boolean isForceReindex()

Has re-index been called ?

Returns:

true if we should re-index

getPureValue

@CheckReturnValue
 @Nullable
public final java.lang.Object getPureValue(@Nullable
                                                                        DBField field,
                                                                        @Nullable
                                                                        FldParams params)

Returns the pure value for this field. This method is marked as final so if not marked as derived it'll be the actual value in the database.

Parameters:

params - The parameters for this field eg. language= or default=

field - The field to get

Returns:

The value of this field in this record.

calculateValue

@CheckReturnValue
 @Nullable
public final java.lang.Object calculateValue(@Nullable
                                                                          DBField field,
                                                                          @Nullable
                                                                          FldParams params)
                                                                   throws java.lang.Exception

Calculate the field value.

Parameters:

field - The field

params - The field parameters

Returns:

the value

Throws:

java.lang.Exception - calculate may throw an exception

calculateValue

@CheckReturnValue
 @Nullable
public final java.lang.Object calculateValue(@Nonnull
                                                                          java.lang.String name)
                                                                   throws java.lang.Exception

Calls the primary getField

Parameters:

name - The name of the field.

Returns:

The value of the field

Throws:

java.lang.Exception - calculate may throw an exception

calculateValue

@CheckReturnValue
 @Nullable
public final java.lang.Object calculateValue(@Nonnull
                                                                          java.lang.String name,
                                                                          @Nullable
                                                                          FldParams params)
                                                                   throws java.lang.Exception

Calls the primary getField

Parameters:

params - The parameters for this field eg. language= or default=

name - The name of the field.

Returns:

The value of the field

Throws:

java.lang.Exception - calculate may throw an exception

getValue

@CheckReturnValue
 @Nullable
public final java.lang.Object getValue(@Nullable
                                                                    DBField field,
                                                                    @Nullable
                                                                    FldParams params)

Calls the extGetValue

Parameters:

params - The parameters for this request

field - The field to get

Returns:

The value of the field

See Also:

extGetValue() To filter public accessible values eg. **** for a password

getValue

@CheckReturnValue
 @Nullable
public final java.lang.Object getValue(@Nonnull
                                                                    DBField field)

calls the primary getValue

Parameters:

field - The field to get

Returns:

The value of the field

See Also:

extGetValue() To filter public accessible values eg. **** for a password

getValue

@CheckReturnValue
 @Nullable
public final java.lang.Object getValue(@Nonnull
                                                                    java.lang.String name)

Calls the primary getField

Parameters:

name - The name of the field.

Returns:

The value of the field

See Also:

extGetValue() To filter public accessible values eg. **** for a password

getValue

@CheckReturnValue
 @Nullable
public final java.lang.Object getValue(@Nonnull
                                                                    java.lang.String name,
                                                                    @Nullable
                                                                    FldParams params)

Calls the primary getField

Parameters:

params - The parameters for this field eg. language= or default=

name - The name of the field.

Returns:

The value of the field

See Also:

extGetValue() To filter public accessible values eg. **** for a password

getFormattedString

@CheckReturnValue
 @Nonnull
public final java.lang.String getFormattedString(@Nullable
                                                                             DBField field,
                                                                             @Nullable
                                                                             java.lang.String specificFormat,
                                                                             @Nullable
                                                                             FldParams params)

Returns the formatted value of the field.

Boolean fields -------------- "True|False" or "Sexy|Ugly" or "on|off" or anything separated by a '|' Date & Timestamp fields ----------------------- We use the standard Java SimpleDateFormat patterns Integer and Long fields ----------------------- We use the standard Java DecimalFormat patterns

Parameters:

params - The parameters for this field eg. language= or default=

field - The field to get.

specificFormat - The format

Returns:

The formatted string

getProcessedValue

@CheckReturnValue
 @Nullable
public final java.lang.Object getProcessedValue(@Nullable
                                                                             DBField field,
                                                                             @Nullable
                                                                             FldParams params)

getFormattedString

@CheckReturnValue
 @Nonnull
public final java.lang.String getFormattedString(@Nullable
                                                                             java.lang.String name,
                                                                             @Nullable
                                                                             java.lang.String specificFormat,
                                                                             @Nullable
                                                                             FldParams params)

Returns the formatted value of the field.

Boolean fields -------------- "True|False" or "Sexy|Ugly" or "on|off" or anything separated by a '|' Date & Timestamp fields ----------------------- We use the standard Java SimpleDateFormat patterns Integer and Long fields ----------------------- We use the standard Java DecimalFormat patterns

Parameters:

params - The parameters for this field eg. language= or default=

name - The field name to be formatted

specificFormat - The format

Returns:

The formatted string

getString

@CheckReturnValue
 @Nonnull
public final java.lang.String getString(@Nonnull
                                                                    DBField field)

Get String

Parameters:

field - The field to get.

Returns:

The string value

See Also:

extGetValue() To filter public accessible values eg. **** for a password

getString

@CheckReturnValue
 @Nonnull
public final java.lang.String getString(@Nonnull
                                                                    DBField field,
                                                                    @Nullable
                                                                    java.lang.String params)

Get String

Parameters:

params - The parameters for this field eg. language= or default=

field - The field to get.

Returns:

The string value

See Also:

extGetValue() To filter public accessible values eg. **** for a password

getString

@CheckReturnValue
 @Nonnull
public final java.lang.String getString(@Nonnull
                                                                    java.lang.String name,
                                                                    @Nullable
                                                                    java.lang.String params)

Get String

Parameters:

name - The name of the field

params - The parameters for this field eg. language= or default=

Returns:

The string value

See Also:

extGetValue() To filter public accessible values eg. **** for a password

getFieldString

@CheckReturnValue
 @Nonnull
public java.lang.String getFieldString(@Nonnull
                                                                   java.lang.String fieldName,
                                                                   java.lang.String... args)

getFieldInt

@CheckReturnValue
public int getFieldInt(@Nonnull
                                         java.lang.String fieldName,
                                         java.lang.String... args)

getFieldLong

@CheckReturnValue
public long getFieldLong(@Nonnull
                                           java.lang.String fieldName,
                                           java.lang.String... args)

getFieldDouble

@CheckReturnValue
public double getFieldDouble(@Nonnull
                                               java.lang.String fieldName,
                                               java.lang.String... args)

getString

@CheckReturnValue
 @Nonnull
public final java.lang.String getString(@Nonnull
                                                                    DBField field,
                                                                    @Nullable
                                                                    FldParams params)

Get String

Parameters:

params - The parameters for this field eg. language= or default=

field - The field to get.

Returns:

The string value

See Also:

extGetValue() To filter public accessible values eg. **** for a password

getString

@CheckReturnValue
 @Nonnull
public final java.lang.String getString(@Nonnull
                                                                    java.lang.String name)

Get String

Parameters:

name - The name of the field

Returns:

The string value

See Also:

extGetValue() To filter public accessible values eg. **** for a password

getString

@CheckReturnValue
 @Nonnull
public final java.lang.String getString(@Nonnull
                                                                    java.lang.String name,
                                                                    @Nullable
                                                                    FldParams params)

Get String

Parameters:

params - The parameters for this field eg. language= or default=

name - The name of the field

Returns:

The string value

See Also:

extGetValue() To filter public accessible values eg. **** for a password

getInt

@CheckReturnValue
public final int getInt(@Nonnull
                                          DBField field)

Get Int

Parameters:

field - The field to get.

Returns:

The int value

See Also:

extGetValue() To filter public accessible values eg. **** for a password

getInt

@CheckReturnValue
public final int getInt(@Nonnull
                                          DBField field,
                                          int defaultValue)

Get Int

Parameters:

defaultValue - The default value

field - The field to get.

Returns:

The int value

See Also:

extGetValue() To filter public accessible values eg. **** for a password

getInt

@CheckReturnValue
public final int getInt(@Nonnull
                                          java.lang.String name,
                                          int defaultValue)

Get Int

Parameters:

name - The field name

defaultValue - the default value

Returns:

The int value

See Also:

extGetValue() To filter public accessible values eg. **** for a password

getInt

@CheckReturnValue
public final int getInt(@Nonnull
                                          java.lang.String name,
                                          @Nullable
                                          FldParams params)

Get Int

Parameters:

name - The field name

params - The parameters for this field eg. language= or default=

Returns:

The int value

See Also:

extGetValue() To filter public accessible values eg. **** for a password

getInt

@CheckReturnValue
public final int getInt(@Nonnull
                                          java.lang.String name)

Get Int

Parameters:

name - The field Name

Returns:

The int value

See Also:

extGetValue() To filter public accessible values eg. **** for a password

getInt

@CheckReturnValue
public final int getInt(@Nonnull
                                          DBField field,
                                          @Nullable
                                          FldParams params)

Get Int

Parameters:

field - The field

params - The parameters for this field eg. language= or default=

Returns:

The int value

See Also:

extGetValue() To filter public accessible values eg. **** for a password

getDouble

@CheckReturnValue
public final double getDouble(@Nonnull
                                                DBField field)

Get Double

Parameters:

field - The field to get.

Returns:

The double value

See Also:

extGetValue() To filter public accessible values eg. **** for a password

getDouble

@CheckReturnValue
public final double getDouble(@Nonnull
                                                java.lang.String name,
                                                double defaultValue)

Get Double

Parameters:

name - The field name

defaultValue - The default value.

Returns:

The double value

See Also:

extGetValue() To filter public accessible values eg. **** for a password

getDouble

@CheckReturnValue
public final double getDouble(@Nonnull
                                                java.lang.String name)

Get Double

Parameters:

name - The name of the field

Returns:

The double value

See Also:

extGetValue() To filter public accessible values eg. **** for a password

getDouble

@CheckReturnValue
public final double getDouble(@Nonnull
                                                DBField field,
                                                double defaultValue)

Get Double

Parameters:

field - The field

defaultValue - The default value for the field.

Returns:

The double value

See Also:

extGetValue() To filter public accessible values eg. **** for a password

getDouble

@CheckReturnValue
public final double getDouble(@Nonnull
                                                java.lang.String field,
                                                @Nullable
                                                FldParams params)

Get Double

Parameters:

field - The field

params - The field parameters

Returns:

The double value

See Also:

extGetValue() To filter public accessible values eg. **** for a password

getLong

@CheckReturnValue
public final long getLong(@Nonnull
                                            DBField field)

Get Long

Parameters:

field - The field to get.

Returns:

The long value

See Also:

extGetValue() To filter public accessible values eg. **** for a password

getLong

@CheckReturnValue
public final long getLong(@Nonnull
                                            java.lang.String name,
                                            long defaultValue)

Get Long

Parameters:

name - The field name

defaultValue - The default value for the field

Returns:

The long value

See Also:

extGetValue() To filter public accessible values eg. **** for a password

getLong

@CheckReturnValue
public final long getLong(@Nonnull
                                            java.lang.String name,
                                            @Nullable
                                            FldParams params)

Get Long

Parameters:

name - The field name

params - the field arguments

Returns:

The long value

See Also:

extGetValue() To filter public accessible values eg. **** for a password

getLong

@CheckReturnValue
public final long getLong(@Nonnull
                                            java.lang.String name)

Get Long

Parameters:

name - The field name

Returns:

The long value

See Also:

extGetValue() To filter public accessible values eg. **** for a password

getLong

@CheckReturnValue
public final long getLong(@Nonnull
                                            DBField field,
                                            long defaultValue)

Get Long

Parameters:

field - The field

defaultValue - The default value.

Returns:

The long value

See Also:

extGetValue() To filter public accessible values eg. **** for a password

getLong

@CheckReturnValue
public final long getLong(@Nonnull
                                            DBField field,
                                            @Nullable
                                            FldParams params)

Get Long

Parameters:

field - The field

params - the field arguments

Returns:

The long value

See Also:

extGetValue() To filter public accessible values eg. **** for a password

getBoolean

@CheckReturnValue
public final boolean getBoolean(@Nonnull
                                                  DBField field)

Get Boolean

Parameters:

field - The field to get.

Returns:

The boolean value

See Also:

extGetValue() To filter public accessible values eg. **** for a password

getBoolean

@CheckReturnValue
public final boolean getBoolean(@Nullable
                                                  DBField field,
                                                  boolean flag)

Get Boolean

Parameters:

field - The field to get.

flag - The default value

Returns:

The boolean value

See Also:

extGetValue() To filter public accessible values eg. **** for a password

getBoolean

@CheckReturnValue
public final boolean getBoolean(@Nonnull
                                                  DBField field,
                                                  @Nullable
                                                  FldParams params)

The boolean value

Parameters:

field - The field

params - The parameters

Returns:

The value

getBoolean

@CheckReturnValue
public final boolean getBoolean(@Nonnull
                                                  java.lang.String name,
                                                  @Nullable
                                                  FldParams params)

The boolean value for a field

Parameters:

name - The field name

params - The parameters

Returns:

The boolean value

getBoolean

@CheckReturnValue
public final boolean getBoolean(@Nonnull
                                                  java.lang.String name)

Get Boolean

Parameters:

name - The field name

Returns:

The boolean value

See Also:

extGetValue() To filter public accessible values eg. **** for a password

getBoolean

@CheckReturnValue
public final boolean getBoolean(@Nonnull
                                                  java.lang.String name,
                                                  boolean flag)

Get Boolean

Parameters:

name - The Field Name

flag - The default value

Returns:

The boolean value

See Also:

extGetValue() To filter public accessible values eg. **** for a password

getDate

@CheckReturnValue
 @Nullable
public final java.util.Date getDate(@Nonnull
                                                                 DBField field)

Get Date

Parameters:

field - The field to get.

Returns:

The Date value

See Also:

extGetValue() To filter public accessible values eg. **** for a password

getDate

@CheckReturnValue
 @Nullable
public final java.util.Date getDate(@Nonnull
                                                                 DBField field,
                                                                 @Nullable
                                                                 java.util.Date defaultDate)

Get Date

Parameters:

field - The field to get.

defaultDate - The default value

Returns:

The date value

See Also:

extGetValue() To filter public accessible values eg. **** for a password

getDate

@CheckReturnValue
 @Nullable
public final java.util.Date getDate(@Nonnull
                                                                 java.lang.String name)

Get Date

Parameters:

name - The field name

Returns:

The date value

See Also:

extGetValue() To filter public accessible values eg. **** for a password

getDate

@CheckReturnValue
 @Nullable
public final java.util.Date getDate(@Nonnull
                                                                 java.lang.String name,
                                                                 @Nullable
                                                                 java.util.Date theDate)

Get Date

Parameters:

name - The Field Name

theDate - The default value

Returns:

The date value

See Also:

extGetValue() To filter public accessible values eg. **** for a password

getDate

@CheckReturnValue
 @Nullable
public final java.util.Date getDate(@Nonnull
                                                                 java.lang.String name,
                                                                 @Nullable
                                                                 FldParams params)

Get Date

Parameters:

name - The Field Name

params - The field parameters

Returns:

The date value

getRawValue

@CheckReturnValue
 @Nullable
public final java.lang.Object getRawValue(@Nonnull
                                                                       GlobalKey fieldId)

Returns the raw value for this field from the underlying DBData or the updated fields.

Parameters:

fieldId - The field's global key

Returns:

The raw value

getRawValue

@CheckReturnValue
 @Nullable
public final java.lang.Object getRawValue(@Nonnull
                                                                       DBField field)

Returns the raw value for this field from the underlying DBData or the updated fields.

Parameters:

field - The field to get the raw value.

Returns:

The Raw value.

getOriginalValue

@CheckReturnValue
 @Nullable
public final java.lang.Object getOriginalValue(@Nonnull
                                                                            GlobalKey fieldKey)

Returns the original value for this field from the underlying DBData.

Parameters:

fieldKey - The field key

Returns:

The original value.

getOriginalValue

@CheckReturnValue
 @Nullable
public final java.lang.Object getOriginalValue(@Nullable
                                                                            DBField field)

Returns the original value for this field from the underlying DBData.

Parameters:

field - The field to get the raw value.

Returns:

The original value.

getOriginalKey

@CheckReturnValue
 @Nullable
public final GlobalKey getOriginalKey(@Nullable
                                                                   DBField field)

Returns the original key for this field from the underlying DBData.

Parameters:

field - The field to get the raw value.

Returns:

The original value.

copyFields

public final void copyFields(@Nonnull
                             DBObject orig)
                      throws java.lang.Exception

Copies the fields from another DBObject into this one. fields such as derived and keys are ignored

Parameters:

orig - The original object to be copied.

Throws:

java.lang.Exception - A serious error.

copyIncludeField

@CheckReturnValue
public boolean copyIncludeField(@Nonnull
                                                  DBObject orig,
                                                  @Nonnull
                                                  DBField field)
                                           throws java.lang.Exception

To filter the fields not to copy. It can be overridden to add additional functionality.

Parameters:

orig - The original object to be copied.

field - The field to be copied

Returns:

false if the field is not allowed to copy.

Throws:

java.lang.Exception - A serious error.

copyInwardLinks

@Nonnull
public final DBObject[] copyInwardLinks(@Nonnull
                                                 DBObject orig,
                                                 @Nonnull
                                                 DBField linkedField)
                                          throws java.lang.Exception

Copies the objects pointing to this object.

Parameters:

orig - The reference object

linkedField - The Linked Field ?

Returns:

The objects

Throws:

java.lang.Exception - A serious problem

markSavePoint

public final void markSavePoint(@Nonnull
                                java.lang.String id)
                         throws NotInUniverseException

Mark the save point which we can rollback to later.

Parameters:

id - the save point id

Throws:

NotInUniverseException - DBObject had not been touched

rollbackTo

public final void rollbackTo(@Nonnull
                             java.lang.String id)
                      throws NoSavePointException

Rollback to save point.

Parameters:

id - the save point id

Throws:

NoSavePointException - no save point found

dump

public final void dump()

DEBUG dump of the current object's fields values to std. out

makeSearchPlan

@CheckReturnValue
 @Nonnull
public static SearchPlan makeSearchPlan(@Nonnull
                                                                    DBQuery<DBObject> query)

Allows for specific attributes to be set for the queries

Parameters:

query - The calling query

Returns:

The search plan

getLockedTransaction

@CheckReturnValue
 @Nonnegative
public final long getLockedTransaction()

The locked transaction number

Returns:

The transaction number

optLockedTransaction

@Nonnegative
public final long optLockedTransaction()
                                             throws java.lang.Exception

If not previously called, use the current transaction when updating the database.

Returns:

the transaction locked.

Throws:

java.lang.Exception - A serious problem.

forceLockedTransaction

@Nonnegative
public final long forceLockedTransaction()
                                               throws java.lang.Exception

Use the current transaction number when applying the changes to the database.

Returns:

the transaction locked.

Throws:

java.lang.Exception - A serious problem.

iPreValidate

public final void iPreValidate()
                        throws java.lang.Exception

Internal Only

Throws:

java.lang.Exception - a serious problem

iRaiseEvents

public final void iRaiseEvents()
                        throws java.lang.Exception

INTERNAL USE ONLY

Add Events to the EventQueue which have conditions that match the current status of the Object. The EventQueue entries will be validated on the next pass to ensure that all the Event's validations pass. If this is the case then any actions will then go on to be processed as part of the preSave

Throws:

java.lang.Exception - A serious problem

iPreSaveOrDeleteRecord

public final void iPreSaveOrDeleteRecord()
                                  throws java.lang.Exception

INTERNAL USE ONLY

Do Auto enter values when a record is about to be saved. This method is called before save and validation if some fields have changed. To add functionality to a DBObject before records are saved to the database override extPreSaveRecord() and extPreDeleteRecord()

Throws:

java.lang.Exception - A Serious problem

See Also:

extPreSaveRecord(), extPreDeleteRecord()

iPostSaveOrDeleteRecord

public final void iPostSaveOrDeleteRecord(@Nonnegative
                                          long transNr)

INTERNAL USE ONLY

Called by the Mutable Data Source after all objects have been saved and commited

Parameters:

transNr - This transaction number that was just saved.

See Also:

#extPostSave()

iSaveOrDeleteRecord

public final void iSaveOrDeleteRecord(@Nonnegative
                                      long transNr)
                               throws java.lang.Exception

INTERNAL USE ONLY

Called by the mutable data source to during the save process.

Parameters:

transNr - The current transaction number.

Throws:

java.lang.Exception - A serious problem

iValidateRecord

public final void iValidateRecord(@Nonnull
                                  ValidationList list,
                                  @Nullable
                                  java.util.HashMap<GlobalKey,java.util.HashMap<java.lang.String,java.util.ArrayList<DBObject>>> possibleConflicts)
                           throws java.lang.Exception

INTERNAL USE ONLY

Performs validations on this record. Override extValidateRecord to supply additional validations. The returned vector is a list of validationItems which may be warnings or errors.

Parameters:

list - The validation list

possibleConflicts - The list of rows matching key and unique field values. This is done by a batch select to improve performance.

Throws:

java.lang.Exception - A serious problem

fireEventDataLoaded

public final void fireEventDataLoaded()

INTERNAL USE ONLY

This method is called when the underlying DBData is changed / loaded. This may be call via other threads saving the object. Once a internal functions are performed the method eventDataLoaded is called which may be overridden by classes extending DBObject.

clearCache

@OverridingMethodsMustInvokeSuper
protected void clearCache(@Nullable
                                                            GlobalKey changedKey)

Automatically called for eventDataLoaded() with this GlobalKey and getCleanVersion() with null for the global key. The design should clear ALL cache if the changedKey is null.

Parameters:

changedKey - The key that was changed.

setRawData

public final void setRawData(@Nullable
                             DBDataInterface data)

INTERNAL USE ONLY

When a DataSource initiates a DBObject the Raw Data is set for existing DBObjects

Parameters:

data - The raw data

getRawData

@CheckReturnValue
 @Nullable
public final DBDataInterface getRawData()

INTERNAL USE ONLY

Returns:

The raw data object for this DBObject

findRawData

@CheckReturnValue
 @Nonnull
public final DBDataInterface findRawData()

registerWatchedObject

public final void registerWatchedObject(@Nonnull
                                        DBObject obj)

INTERNAL USE ONLY

When a object is being watched by another object we store a hard link to the watched object from the watcher to prevent watch objects from being GCed.

An example is DBClass stores information about the associated fields. It places a watch on these fields so that an event is raised in DBClass when a DBField is loaded/changed.

Parameters:

obj - The database object to be watched.

hashCode

@CheckReturnValue
public final int hashCode()

Please don't overload this method as it'll cause odd errors where internal messages will be lost. This is final method to CAUSE a compile error if a developer does the wrong thing.

Overrides:

hashCode in class java.lang.Object

Returns:

The normal value

equals

@CheckReturnValue
public final boolean equals(@Nullable
                                              java.lang.Object o)

Please don't overload this method as it'll cause odd errors where internal messages will be lost. This is final method to CAUSE a compile error if a developer does the wrong thing.

Overrides:

equals in class java.lang.Object

Parameters:

o - The normal value

Returns:

The normal value

iSetValue

protected final void iSetValue(@Nullable
                               DBField field,
                               @Nullable
                               java.lang.Object userValue,
                               @Nullable
                               FldParams params)
                        throws java.lang.Exception

If the currentValue is a DBObject it'll be converted to a GlobalKey

Parameters:

userValue - The new value

params - The parameters for this field eg. language= or default=

field - The field to update

Throws:

java.lang.Exception - A serious problem

getMutableArrayValue

@CheckReturnValue
 @Nonnull
public final MutableArrayValue getMutableArrayValue(@Nonnull
                                                                                java.lang.String name)
                                                                         throws java.lang.Exception

Get the mutable array value

Parameters:

name - The name of the field

Returns:

The array value

Throws:

java.lang.Exception - must be mutable and an array field

getMutableArrayValue

@CheckReturnValue
 @Nonnull
public final MutableArrayValue getMutableArrayValue(@Nonnull
                                                                                DBField field)
                                                                         throws java.lang.Exception

Get the mutable array value

Parameters:

field - the array field

Returns:

The array value

Throws:

java.lang.Exception - must be mutable and an array field

iGetRawValue

@Nullable
protected final java.lang.Object iGetRawValue(@Nonnull
                                                        DBField field)

An optimized version of getRawField.

Parameters:

field - The field to get

Returns:

The value of the field

eventFieldUpdated

@OverridingMethodsMustInvokeSuper
protected void eventFieldUpdated(@Nonnull
                                                                   DBField field,
                                                                   @Nullable
                                                                   java.lang.Object previous,
                                                                   @Nullable
                                                                   GlobalKey previousKey,
                                                                   @Nullable
                                                                   FldParams params)
                                                            throws java.lang.Exception

OVERRIDE This method to be notified when a field changes. This method should not trigger a save of this record because you may save a record in a half updated state.
TODO: Put in a programmer check for a save during this method call.

Parameters:

field - The field updated.

previous - The previous value for this field.

previousKey - The previous key

params - The parameters used

Throws:

java.lang.Exception - a serious problem

extIsMandatory

@CheckReturnValue
protected boolean extIsMandatory(@Nonnull
                                                   DBField field)

OVERRIDE This method to specify fields should be mandatory under certain conditions.

Parameters:

field - The field to check

Returns:

true if the field should be treated as mandatory.

extIsOnChange

@CheckReturnValue
protected boolean extIsOnChange(@Nonnull
                                                  DBField field)

OVERRIDE This method to specify that when a field is updated it will affect other fields.

Parameters:

field - The field to check

Returns:

true if the field affects others when changed

extGetDerivedValue

@CheckReturnValue
 @Nullable
protected java.lang.Object extGetDerivedValue(@Nonnull
                                                                           DBField field,
                                                                           @Nullable
                                                                           FldParams params)
                                                                    throws java.lang.Exception

OVERRIDE This method for all objects with derived fields that are NOT linked. A linked derived field should extend the extGetDerivedGlobalKey.

Parameters:

params - The parameters for this field eg. language= or default=

field - The field to get

Returns:

The value of the field.

Throws:

java.lang.Exception - a serious problem

extGetDerivedGlobalKey

@CheckReturnValue
 @Nullable
protected GlobalKey extGetDerivedGlobalKey(@Nonnull
                                                                        DBField field,
                                                                        @Nullable
                                                                        FldParams params)
                                                                 throws java.lang.Exception

OVERRIDE This method to return a derived global key. This method is only checked if the field is marked as being linked.

Parameters:

field - The field that is being changed

params - The extra parameters

Returns:

The Global key

Throws:

java.lang.Exception - A serious problem. In general validation is done later.

extCanDeleteDependantObject

@CheckReturnValue
protected boolean extCanDeleteDependantObject(@Nonnull
                                                                DBObject o)

OVERRIDE This method to Alter the default behaviour of check if we can remove a dependent object. The normal check to see if a dependent object can be deleted is if that object is new or is marked as "parentCanDeleteChild" and that any object that depends on the dependent also complies.

Parameters:

o - The object to check

Returns:

true if we can delete this object.

extGetValue

@CheckReturnValue
 @Nullable
protected java.lang.Object extGetValue(@Nullable
                                                                    DBField field,
                                                                    @Nullable
                                                                    FldParams params)

This is the PRIMARY "get" method which returns the processed field value for this object. If additional processing is require for a field the normal way of archiving this would be to declare it as derived and then add the processing to extGetDerivedValue but this method may be also overridden to add this additional functionality.

Please note: if a field is not declared DERIVED and the field value is changed by the overriding this method, a database search for this field may return unexpected results.
When overriding the extGetValue method the SAME value should be return. Examples of use are to blank fields that you don't have access to or to return ***** instead of the password. The database search uses getPureField which is final so you could do a search for a field value even if it is being blanked. Real security can only be given by creating an associated record and supplying a ACL to restrict access to it.

Parameters:

params - The parameters for this field eg. language= or default=

field - The field to get

Returns:

The value of the field.

extFixUp

@OverridingMethodsMustInvokeSuper
protected void extFixUp()
                                                   throws java.lang.Exception

The extended fix up routine

Throws:

java.lang.Exception - a serious problem

extAutoEnterCreate

@OverridingMethodsMustInvokeSuper
protected void extAutoEnterCreate()
                                                             throws java.lang.Exception

Extend this method to add functionality when a new DBObject is created.
You may need to create a FldParams, and setIsAutoEntered(true) so that system does not misunderstand that this object is changed by user.

Throws:

java.lang.Exception - A serious problem

extValidateDelete

@OverridingMethodsMustInvokeSuper
protected void extValidateDelete(@Nonnull
                                                                   ValidationList list)
                                                            throws java.lang.Exception

Extend this method to add validation to a record then deleted.

Parameters:

list - The validation list

Throws:

java.lang.Exception - A serious problem

extDelete

@OverridingMethodsMustInvokeSuper
protected void extDelete()
                                                    throws java.lang.Exception

Additional functionality when an object is marked for deletion by calling delete().

Throws:

java.lang.Exception - A serious problem

extUndelete

@OverridingMethodsMustInvokeSuper
protected void extUndelete()
                                                      throws java.lang.Exception

Additional functionality when an object is undeleted.

Throws:

java.lang.Exception - A serious problem

extCopy

@OverridingMethodsMustInvokeSuper
protected void extCopy(@Nonnull
                                                         DBObject target)
                                                  throws java.lang.Exception

Additional functionality when an object is copied.

Parameters:

target - the target object

Throws:

java.lang.Exception - A serious problem

extCheckCreateAccess

@OverridingMethodsMustInvokeSuper
protected void extCheckCreateAccess()
                                                               throws DBAccessException

Additional access checking for create access of this object.

Throws:

DBAccessException - No access to create

extCheckDeleteAccess

@OverridingMethodsMustInvokeSuper
protected void extCheckDeleteAccess()
                                                               throws DBAccessException

Additional access checking for delete access of this object.

Throws:

DBAccessException - No access to delete

extCheckReadAccess

@OverridingMethodsMustInvokeSuper
protected void extCheckReadAccess()
                                                             throws DBAccessException

Additional access checking for read access of this object.

Throws:

DBAccessException - No access to read

extCheckModifyAccess

@OverridingMethodsMustInvokeSuper
protected void extCheckModifyAccess()
                                                               throws DBAccessException

Additional access checking for write access of this object.

Throws:

DBAccessException - No access to modify

extCheckModifyAccess

@OverridingMethodsMustInvokeSuper
protected void extCheckModifyAccess(@Nonnull
                                                                      DBField field)
                                                               throws DBAccessException

Additional access checking for write access for a field of this object.

Parameters:

field - Can we change this field ?

Throws:

DBAccessException - No access to change

extPreSaveRecord

@OverridingMethodsMustInvokeSuper
protected void extPreSaveRecord()
                                                           throws java.lang.Exception

OVERRIDE this method to add functionality to stSoftware BEFORE saving the record to the database. At this stage the final validation ( internally called by save) has NOT been performed. This is your chance to create other associated records etc. This method is called for all created and modified records NOT deleted. The database transaction has not been started yet. Your changes will NOT be rollback in case of failure.

Throws:

java.lang.Exception - A Serious problem

extPreDeleteRecord

@OverridingMethodsMustInvokeSuper
protected void extPreDeleteRecord()
                                                             throws java.lang.Exception

OVERRIDE this method to add functionality to stSoftware BEFORE deleting a record from the database. At this stage the final validation ( internally called by save) has NOT been performed. This is your chance to create other associated records etc. This method is called for all created and modified records NOT deleted. The database transaction has not been started yet. Your changes will NOT be rollback in case of failure.

Throws:

java.lang.Exception - A Serious problem

extDeleteRecord

@OverridingMethodsMustInvokeSuper
protected void extDeleteRecord(@Nonnegative
                                                                 long transNr)
                                                          throws java.lang.Exception

OVERRIDE this method to add functionality to stSoftware WHILE deleting the record from the database. At this stage we are within a database transaction. YOU MAY NOT CHANGE THE UNIVERSE AT THIS STAGE.

Parameters:

transNr - This transaction number that was just saved.

Throws:

java.lang.Exception - A serious Error

extSaveRecord

@OverridingMethodsMustInvokeSuper
protected void extSaveRecord(@Nonnegative
                                                               long transNr)
                                                        throws java.lang.Exception

OVERRIDE this method to add functionality to stSoftware WHILE saving the record to the database. At this stage we are within a database transaction. YOU MAY NOT CHANGE THE UNIVERSE AT THIS STAGE.

Parameters:

transNr - This transaction number that was just saved.

Throws:

java.lang.Exception - A serious Error

extPostDeleteRecord

@OverridingMethodsMustInvokeSuper
protected void extPostDeleteRecord(@Nonnegative
                                                                     long transNr)

OVERRIDE this method to add functionality to stSoftware AFTER deleting the record from the database. At this stage the database transaction has been committed. YOU MAY NOT CHANGE THE UNIVERSE AT THIS STAGE.

Parameters:

transNr - This transaction number that was just saved.

extPostSaveRecord

@OverridingMethodsMustInvokeSuper
protected void extPostSaveRecord(@Nonnegative
                                                                   long transNr)

OVERRIDE this method to add functionality to stSoftware AFTER saving the record to the database. At this stage the database transaction has been committed. YOU MAY NOT CHANGE THE UNIVERSE AT THIS STAGE.

Parameters:

transNr - This transaction number that was just saved.

eventDataLoaded

@OverridingMethodsMustInvokeSuper
protected void eventDataLoaded()

When the underlying DBData is changed/ loaded. This may be call via other threads/servers saving the object.
OVERRIDE this method to add clear cache items on reload.

extSetValue

protected void extSetValue(@Nonnull
                           DBField field,
                           @Nullable
                           java.lang.Object currentValue,
                           @Nullable
                           FldParams params)
                    throws java.lang.Exception

OVERRIDE This method to filter ALL public calls to SetValue. This method is called BEFORE the field is changed.

You can use this method to implement things like composite keys where the key value is made up of two or more other fields. So when field1 or field2 is updated we call iSetValue to change the key value and in extSetValue we ignore any value set by the user/screen for the key field.

Parameters:

field - The field that is being changed

currentValue - The new value

params - The extra parameters

Throws:

java.lang.Exception - A serious problem. In general validation is done later.

extPreValidate

@OverridingMethodsMustInvokeSuper
protected void extPreValidate()
                                                         throws java.lang.Exception

OVERRIDE To add functionality to before validation is called.

THIS IS YOUR LAST CHANCE TO MAKE CHANGES BEFORE VALIDATIONS.

Throws:

java.lang.Exception - a serious problem

extPreValidateDelete

@OverridingMethodsMustInvokeSuper
protected void extPreValidateDelete()
                                                               throws java.lang.Exception

OVERRIDE To add functionality to before validation is called.

THIS IS YOUR LAST CHANCE TO MAKE CHANGES BEFORE VALIDATIONS FOR DELETED RECORDS.

Throws:

java.lang.Exception - a serious problem

extRaiseEvents

@OverridingMethodsMustInvokeSuper
protected void extRaiseEvents()
                                                         throws java.lang.Exception

raise the events

Throws:

java.lang.Exception - A serious problem

extValidateRecord

@OverridingMethodsMustInvokeSuper
protected void extValidateRecord(@Nonnull
                                                                   ValidationList list)
                                                            throws java.lang.Exception

Performs additional validations on this record. OVERRIDE this method to add additional validations to a record.
The MutableDataSource is in READONLY mode at this stage.

Parameters:

list - The validation list.

Throws:

java.lang.Exception - A serious problem

extMarkSavePoint

@OverridingMethodsMustInvokeSuper
protected void extMarkSavePoint(@Nonnull
                                                                  java.lang.String id)
                                                           throws NotInUniverseException

Mark the save point which we can rollback to later.

Parameters:

id - the save point id

Throws:

NotInUniverseException - DBObject had not been touched

extRollbackTo

@OverridingMethodsMustInvokeSuper
protected void extRollbackTo(@Nonnull
                                                               java.lang.String id)
                                                        throws NoSavePointException

Rollback to save point.

Parameters:

id - the save point id

Throws:

NoSavePointException - no save point found

extValidateField

@OverridingMethodsMustInvokeSuper
 @Nullable
 @CheckReturnValue
protected ValidationError extValidateField(@Nonnull
                                                                                                           DBField field,
                                                                                                           @Nonnull
                                                                                                           ValidationList list)
                                                                                                    throws java.lang.Exception

Additional validation for particular field OVERRIDE THIS METHOD TO ADD VALIDATIONS FOR A FIELD.

OVERRIDE this method to add validation to a field but call iValidateField to perform the full validation for a field.

This method should be READ ONLY. Don't create DBObjects here.
When overriding this method the following code stub should be used.
ValidationError ve;
ve = super.extValidateField( field, list);
if( ve != null) return ve;
if( field.getName().equalsIgnoreCase( DBFIELD_FIELD1))
{
return list.createError( DBMessage.LIST_DB_MY_ERROR, this, field);
}
else if( field.getName().equalsIgnoreCase( DBFIELD_FIELD2))
{
....
}

Parameters:

list - The validation list

field - The field to be validated

Returns:

the error or warning.

Throws:

java.lang.Exception - a serious error

validateSubType

protected void validateSubType(@Nonnull
                               DBField field,
                               @Nullable
                               java.lang.Object value)
                        throws InvalidDataException,
                               InvalidDataWarning

http://www.regular-expressions.info/email.html http://tools.ietf.org/html/rfc2822#section-3.4.1

Parameters:

field - The field

value - the value

Throws:

InvalidDataException - invalidate data

InvalidDataWarning

displayValue

@CheckReturnValue
 @Nonnull
public java.lang.String displayValue()

Displays the value of the default display field

Returns:

the display name

displayLogName

@CheckReturnValue
 @Nonnull
public java.lang.String displayLogName()

The human readable object name in the logs.

Returns:

the display name

displayName

@CheckReturnValue
 @Nonnull
public java.lang.String displayName()

The display name

Returns:

the display name