com.aspc.Layers.aspc_app.Misc

Class Suburb

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.Layers.aspc_app.Misc.Suburb

All Implemented Interfaces:

SecondaryCacheGroup

Direct Known Subclasses:

Suburb

public class Suburb
extends DBObject

A sub division of a state or region.

data model
THREAD MODE: MIXED, SINGLE-THREADED when called from MutableDataSource else MULTI-THREADED

Since:

August 2, 2004

Author:

Jason McGrath

Nested Class Summary

Nested classes/interfaces inherited from class com.aspc.DBObj.DBObject

DBObject.DenormalizeAction

Field Summary

Fields

Modifier and Type	Field and Description
static GlobalId	DBCLASS_GID A sub division of a state or region
static java.lang.String	DBCLASS_NAME A sub division of a state or region

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
Suburb(DBClass def, DataSource dataSource) Std.

Method Summary

Modifier and Type	Method and Description
static Suburb	create(MutableDataSource mds) Make a new instance of this class.
protected void	eventFieldUpdated(DBField field, java.lang.Object previous, GlobalKey previousKey, FldParams params) Additional business logic when a field is updated.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) OVERRIDE This method for all objects with derived fields that are NOT linked.
static Suburb	findKey(DataSource ds, java.lang.String key) Find the target for this class by the primary key
Region	findRegion(java.lang.String... args) Region.
StateRegion	findState(java.lang.String... args) State.
static Suburb	findSuburbByCodeOrName(DataSource ds, StateRegion state, java.lang.String suburb) find the suburb in the given state, if state is null, find the first matching suburb
java.lang.String	getCode(java.lang.String... args)
double	getLatitude(java.lang.String... args)
double	getLongitude(java.lang.String... args)
java.lang.String	getName(java.lang.String... args)
java.lang.String	getNameAndPostcode(java.lang.String... args)
java.lang.String	getPostCode(java.lang.String... args)
Region	getRegion(java.lang.String... args)
StateRegion	getState(java.lang.String... args)
static Suburb	getSuburbByNameAndPostCode(java.lang.String suburbName, java.lang.String postCode, java.lang.String state, MutableDataSource mds) retrieve suburb object if exists otherwise create a new suburb
boolean	isCapital(java.lang.String... args)
static DBQuery<Suburb>	makeQuery(DataSource ds) Make a new QUERY for this class.
Suburb	setCapital(boolean value, java.lang.String... args)
Suburb	setCode(java.lang.String value, java.lang.String... args)
Suburb	setLatitude(double value, java.lang.String... args)
Suburb	setLongitude(double value, java.lang.String... args)
Suburb	setName(java.lang.String value, java.lang.String... args)
Suburb	setPostCode(java.lang.String value, java.lang.String... args)
Suburb	setRegion(com.aspc.dal.layers.aspc_app.misc.Region value, java.lang.String... args)
Suburb	setState(com.aspc.dal.layers.aspc_app.misc.StateRegion value, java.lang.String... args)

Methods inherited from class com.aspc.DBObj.DBObject

addReloadEventListener, archiveCheck, autoEnterCreate, calculateValue, calculateValue, calculateValue, callingRestoreByJournal, changeThreadMode, checkCreateAccess, checkDelete, checkDeleteAccess, checkModifyAccess, checkModifyAccess, checkReadAccess, clearCache, copy, copyFields, copyIncludeField, copyInwardLinks, delete, denormalizedResult, displayLogName, displayName, displayValue, doSearch, dump, equals, eventDataLoaded, extAutoEnterCreate, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extFixUp, extGetDerivedGlobalKey, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, extPreValidate, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, extUndelete, extValidateDelete, extValidateField, extValidateRecord, fetchLinkHolder, findGlobalKey, findGlobalKey, findGlobalKey, findGlobalKey, findLinkedObject, findLinkedObject, findLinkedObject, findRawData, fireEventDataLoaded, fixUp, forceLockedTransaction, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getChangedFieldInfo, getChangedFields, getDate, getDate, getDate, getDate, getDate, getDefaultValue, getDisableOnChangeEvent, getDouble, getDouble, getDouble, getDouble, getDouble, getFieldDouble, getFieldInt, getFieldLong, getFieldString, getFormattedString, getFormattedString, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getInt, getInt, getInt, getInt, getInt, getInt, getInwardLinkage, getKeyString, getKeyValue, getLinkedObject, getLinkedObject, getLinkedObject, getLinkedObjectByKey, getLinkedRowId, getLinkedRowId, getLinkedRowIdByData, getLinkHolder, getLockedTransaction, getLong, getLong, getLong, getLong, getLong, getLong, getMutableArrayValue, getMutableArrayValue, getOriginalKey, getOriginalValue, getOriginalValue, getProcessedValue, getPureValue, getRawData, getRawValue, getRawValue, getRowId, getRowKey, getSecondaryCacheGroupKey, getSrcLayerID, getString, getString, getString, getString, getString, getString, getValue, getValue, getValue, getValue, hasAutoChanged, hasAutoChanged, hasChanged, hasChangedByUser, hasChangedByUserField, hasChangedByUserField, hasFieldChanged, hasFieldChanged, hashCode, hasStoredResult, iCheckDeleteAccess, iCheckModifyAccess, iCheckReadAccess, iGetDenormalizedMap, iGetRawValue, iPlaceDenormalizedResult, iPostSaveOrDeleteRecord, iPreSaveOrDeleteRecord, iPreValidate, iRaiseEvents, iSaveOrDeleteRecord, isBrokenLink, isBrokenLink, isChanged, isDataCacheKnownToBeDirty, isDeleted, isEmpty, iSetValue, isForceReindex, isKeyWordField, isMandatory, isNew, isNull, isNull, isOnChange, isReindex, iValidateRecord, lastTouched, makeArchiveDataLoader, makeClone, makeDataLoader, makeDenormalizedDoc, makeLinkedArray, makeModifyAccessException, makeSearchPlan, makeWriteProvider, manualDenormalizeOnSave, markSavePoint, optLockedTransaction, registerWatchedObject, reindex, releaseDenormalized, removeReloadEventListener, restoreByJournal, rollbackTo, setBoolean, setBoolean, setBoolean, setBoolean, setDisableOnChangeEvent, setDouble, setDouble, setInt, setInt, setLong, setLong, setRawData, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, touch, undelete, validateField, validateRecord, validateSubType

Methods inherited from class java.lang.Object

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

Field Detail

DBCLASS_NAME

public static final java.lang.String DBCLASS_NAME

A sub division of a state or region

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

A sub division of a state or region

Constructor Detail

Suburb

public Suburb(DBClass def,
              DataSource dataSource)
       throws java.lang.Exception

Std. DBObject constructor

Parameters:

def - The class of this object

dataSource - The datasource for this object

Throws:

java.lang.Exception - A serious problem occurred

Method Detail

getCode

@CheckReturnValue
 @Nonnull
public java.lang.String getCode(java.lang.String... args)

setCode

@Nonnull
public Suburb setCode(java.lang.String value,
                               java.lang.String... args)
                        throws java.lang.Exception

Throws:

java.lang.Exception

isCapital

@CheckReturnValue
public boolean isCapital(java.lang.String... args)

setCapital

@Nonnull
public Suburb setCapital(boolean value,
                                  java.lang.String... args)
                           throws java.lang.Exception

Throws:

java.lang.Exception

getLatitude

@CheckReturnValue
public double getLatitude(java.lang.String... args)

setLatitude

@Nonnull
public Suburb setLatitude(double value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:

java.lang.Exception

getLongitude

@CheckReturnValue
public double getLongitude(java.lang.String... args)

setLongitude

@Nonnull
public Suburb setLongitude(double value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:

java.lang.Exception

getName

@CheckReturnValue
 @Nonnull
public java.lang.String getName(java.lang.String... args)

setName

@Nonnull
public Suburb setName(java.lang.String value,
                               java.lang.String... args)
                        throws java.lang.Exception

Throws:

java.lang.Exception

getNameAndPostcode

@CheckReturnValue
 @Nonnull
public java.lang.String getNameAndPostcode(java.lang.String... args)

getPostCode

@CheckReturnValue
 @Nonnull
public java.lang.String getPostCode(java.lang.String... args)

setPostCode

@Nonnull
public Suburb setPostCode(java.lang.String value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:

java.lang.Exception

getRegion

@CheckReturnValue
 @Nullable
public Region getRegion(java.lang.String... args)

findRegion

@CheckReturnValue
 @Nonnull
public final Region findRegion(java.lang.String... args)
                                                    throws NotFoundException

Region.

--> Region (String, Searchable)

Parameters:

args - the optional arguments

Returns:

Region

Throws:

NotFoundException - Region was not found

setRegion

@Nonnull
public Suburb setRegion(com.aspc.dal.layers.aspc_app.misc.Region value,
                                 java.lang.String... args)
                          throws java.lang.Exception

Throws:

java.lang.Exception

getState

@CheckReturnValue
 @Nullable
public StateRegion getState(java.lang.String... args)

findState

@CheckReturnValue
 @Nonnull
public final StateRegion findState(java.lang.String... args)
                                                        throws NotFoundException

State.

--> StateRegion (String, Searchable)

Parameters:

args - the optional arguments

Returns:

StateRegion

Throws:

NotFoundException - StateRegion was not found

setState

@Nonnull
public Suburb setState(com.aspc.dal.layers.aspc_app.misc.StateRegion value,
                                java.lang.String... args)
                         throws java.lang.Exception

Throws:

java.lang.Exception

create

@Nonnull
 @CheckReturnValue
public static Suburb create(@Nonnull
                                                        MutableDataSource mds)
                                                 throws java.lang.Exception

Make a new instance of this class.

Parameters:

mds - the datasource

Returns:

the new record

Throws:

java.lang.Exception - an object of this class could not be created

makeQuery

@Nonnull
 @CheckReturnValue
public static DBQuery<Suburb> makeQuery(@Nonnull
                                                                    DataSource ds)
                                                             throws NotFoundException

Make a new QUERY for this class.

Parameters:

ds - the datasource

Returns:

the new QUERY

Throws:

NotFoundException - if class could not be found

findKey

@Nonnull
 @CheckReturnValue
public static Suburb findKey(@Nonnull
                                                         DataSource ds,
                                                         @Nonnull
                                                         java.lang.String key)
                                                  throws NotFoundException,
                                                         java.lang.Exception

Find the target for this class by the primary key

Parameters:

ds - the datasource

key - the value

Returns:

the target

Throws:

NotFoundException - if target could not be found

java.lang.Exception - a serious problem

eventFieldUpdated

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

Additional business logic when a field is updated.

Overrides:

eventFieldUpdated in class DBObject

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

See Also:

DBObject.eventFieldUpdated( DBField, Object, GlobalKey, FldParams)

extGetDerivedValue

@CheckReturnValue
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.

Overrides:

extGetDerivedValue in class DBObject

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

getSuburbByNameAndPostCode

public static Suburb getSuburbByNameAndPostCode(java.lang.String suburbName,
                                                java.lang.String postCode,
                                                java.lang.String state,
                                                MutableDataSource mds)
                                         throws java.lang.Exception

retrieve suburb object if exists otherwise create a new suburb

Parameters:

suburbName - suburbName

postCode - postCode

state -

mds - mds

Returns:

suburb

Throws:

java.lang.Exception - the exception

findSuburbByCodeOrName

public static Suburb findSuburbByCodeOrName(DataSource ds,
                                            StateRegion state,
                                            java.lang.String suburb)
                                     throws java.lang.Exception

find the suburb in the given state, if state is null, find the first matching suburb

Parameters:

ds -

state -

suburb -

Returns:

Throws:

java.lang.Exception