Package com.storedobject.core

Class SerialPattern

java.lang.Object

com.storedobject.core.StoredObject

com.storedobject.core.SerialPattern

All Implemented Interfaces:

Displayable, StringFiller, HasId

public class SerialPattern
extends StoredObject

Field Summary

Fields inherited from class com.storedobject.core.StoredObject

logger

Constructor Summary

Constructors

Constructor	Description
SerialPattern()

Method Summary

Modifier and Type	Method	Description
static void	columns(Columns columns)
static SerialPattern	get(String name)
String	getDescription()
String	getName()
String	getNumber(SystemEntity systemEntity, long serial, Date date)	Get the number string appropriately stuffed as per the pattern.
static String	getNumber(SystemEntity systemEntity, long serial, Date date, String pattern)	Get the number string appropriately stuffed as per the pattern.
String	getNumber(TransactionManager tm, long serial, Date date)	Get the number string appropriately stuffed as per the pattern.
static String	getNumber(TransactionManager tm, long serial, Date date, String pattern)	Get the number string appropriately stuffed as per the pattern.
static String	getNumber(String patternName, SystemEntity systemEntity, long serial, Date date)	Get the number string appropriately stuffed as per the pattern.
static String	getNumber(String patternName, TransactionManager tm, long serial, Date date)	Get the number string appropriately stuffed as per the pattern.
String	getPattern()
String	getUniqueCondition()	Gets the unique index condition of this object.
static int	hints()
static void	indices(Indices indices)
static ObjectIterator<SerialPattern>	list(String name)
void	setDescription(String description)
void	setName(String name)
void	setPattern(String pattern)
static String	stuff(String pattern, char c, long serial)	Replace the occurrence of a give character with the given serial number.
String	toString()	String representation of the instance.
void	validateData(TransactionManager tm)	The system will invoke this whenever the object is saved to the DB.

Methods inherited from class com.storedobject.core.StoredObject

addLink, addLink, addLink, addLink, addLink, addLink, addLink, addLink, checkCurrency, checkCurrency, checkForDuplicate, checkForDuplicate, checkTimeZone, checkTransaction, clearObjectLinks, contemporary, copy, copy, count, count, count, count, count, count, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, create, created, delete, delete, delete, deleted, directUpdate, equals, exists, exists, exists, exists, exists, existsFileData, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsMaster, existsMaster, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, family, family, family, family, fill, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, getActor, getAttachment, getAttachmentId, getChildren, getContemporaryOf, getDeleted, getDeleted, getExistsCondition, getExistsCondition, getFileData, getFileData, getHistorical, getId, getKeyIndex, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getNotExistsCondition, getNotExistsCondition, getParent, getParent, getParent, getParentId, getParentId, getParentId, getRelated, getRelated, getTransaction, getTransactionId, getTransactionIP, getUnique, hashCode, inserted, isModified, isVirtual, list, list, list, list, list, list, list, list, list, list, list, list, list, listDeletedIds, listFileData, listFileData, listHistory, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listTree, listTree, listTree, listTree, listViaQuery, listViaQuery, load, load, load, load, loadAttributesFrom, loaded, loading, makeNew, makeVirtual, migrate, moduleName, nextVersion, objectLink, objectLink, objectLink, objectLinks, objectLinks, old, person, previousVersion, previousVersion, query, query, query, query, query, query, query, query, query, query, query, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, reload, reload, reloaded, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeReverseLinks, removeReverseLinks, save, save, save, save, save, save, save, save, save, save, save, save, save, save, save, saved, saving, setMaster, setRawValue, setTransaction, stringify, tableName, timestamp, toCode, toDisplay, transacting, undelete, undelete, undeleted, updated, user, userId, validate, validateChildAttach, validateChildDetach, validateChildUpdate, validateDelete, validateInsert, validateParentAttach, validateParentDetach, validateParentUpdate, validateUndelete, validateUpdate, valueEquals

Methods inherited from class java.lang.Object

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

Constructor Details

SerialPattern

public SerialPattern()

Method Details

columns

public static void columns(Columns columns)

indices

public static void indices(Indices indices)

getUniqueCondition

public String getUniqueCondition()

Description copied from class: StoredObject

Gets the unique index condition of this object.

Overrides:

getUniqueCondition in class StoredObject

Returns:

Unique index condition.

get

public static SerialPattern get(String name)

list

public static ObjectIterator<SerialPattern> list(String name)

toString

public String toString()

Description copied from class: StoredObject

String representation of the instance. Mostly used for logging purposes.

Overrides:

toString in class StoredObject

Returns:

String representation of the instance.

hints

public static int hints()

setName

public void setName(String name)

getName

@Column(order=100)
public String getName()

setPattern

public void setPattern(String pattern)

getPattern

@Column(required=false,
        order=200)
public String getPattern()

setDescription

public void setDescription(String description)

getDescription

@Column(required=false,
        order=300)
public String getDescription()

validateData

public void validateData(TransactionManager tm)
                  throws Exception

Description copied from class: StoredObject

The system will invoke this whenever the object is saved to the DB. It will be invoked in all cases while creating new objects and updating/deleting/undeleting existing objects. If any exception is raised by this method, the process of saving to the DB will be abandoned.

Note: This method is mainly used to validate the data of all attributes of the object, and it may be used by others for validating the object. For example, front-end data-entry systems can use this method for validating the object.

Overrides:

validateData in class StoredObject

Parameters:

tm - Current transaction manager.

Throws:

Exception - If data is invalid.

getNumber

public String getNumber(TransactionManager tm,
 long serial,
 Date date)

Get the number string appropriately stuffed as per the pattern.

Parameters:

tm - Transaction manager.

serial - Number to stuff in.

date - Date to stuff in.

Returns:

Stuffed number that can be generally used as a unique reference.

getNumber

public String getNumber(SystemEntity systemEntity,
 long serial,
 Date date)

Get the number string appropriately stuffed as per the pattern.

Parameters:

systemEntity - System entity.

serial - Number to stuff in.

date - Date to stuff in.

Returns:

Stuffed number that can be generally used as a unique reference.

getNumber

public static String getNumber(TransactionManager tm,
 long serial,
 Date date,
 String pattern)

Get the number string appropriately stuffed as per the pattern.

Parameters:

tm - Transaction manager.

serial - Number to stuff in.

date - Date to stuff in.

pattern - Pattern.

Returns:

Stuffed number that can be generally used as a unique reference.

getNumber

public static String getNumber(SystemEntity systemEntity,
 long serial,
 Date date,
 String pattern)

Get the number string appropriately stuffed as per the pattern.

Parameters:

systemEntity - System entity.

serial - Number to stuff in.

date - Date to stuff in.

pattern - Pattern.

Returns:

Stuffed number that can be generally used as a unique reference.

getNumber

public static String getNumber(String patternName,
 TransactionManager tm,
 long serial,
 Date date)

Get the number string appropriately stuffed as per the pattern.

Parameters:

patternName - Name of the pattern.

tm - Transaction manager.

serial - Number to stuff in.

date - Date to stuff in.

Returns:

Stuffed number that can be generally used as a unique reference.

getNumber

public static String getNumber(String patternName,
 SystemEntity systemEntity,
 long serial,
 Date date)

Get the number string appropriately stuffed as per the pattern.

Parameters:

patternName - Name of the pattern.

systemEntity - System entity.

serial - Number to stuff in.

date - Date to stuff in.

Returns:

Stuffed number that can be generally used as a unique reference.

stuff

public static String stuff(String pattern,
 char c,
 long serial)

Replace the occurrence of a give character with the given serial number.

Parameters:

pattern - Pattern.

c - Character to look for.

serial - Serial number.

Returns:

Resultant string.