org.jminor.framework.domain.property

Class AuditProperty.DefaultAuditUserProperty

java.lang.Object

org.jminor.framework.domain.property.AuditProperty.DefaultAuditUserProperty

All Implemented Interfaces:

java.io.Serializable, AuditProperty, AuditProperty.AuditUserProperty, ColumnProperty, Property

Enclosing interface:

AuditProperty

public static final class AuditProperty.DefaultAuditUserProperty
extends java.lang.Object
implements AuditProperty.AuditUserProperty

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.jminor.framework.domain.property.AuditProperty

AuditProperty.AuditAction, AuditProperty.AuditTimeProperty, AuditProperty.AuditUserProperty, AuditProperty.DefaultAuditTimeProperty, AuditProperty.DefaultAuditUserProperty

Nested classes/interfaces inherited from interface org.jminor.framework.domain.property.ColumnProperty

ColumnProperty.Builder

Nested classes/interfaces inherited from interface org.jminor.framework.domain.property.Property

Property.ValueProvider

Field Summary

Fields inherited from interface org.jminor.framework.domain.property.Property

BIG_DECIMAL_ROUNDING_MODE, DATE_FORMAT, DEFAULT_FOREIGN_KEY_FETCH_DEPTH, DEFAULT_MAXIMUM_FRACTION_DIGITS, FOREIGN_KEY_FETCH_DEPTH, MAXIMUM_FRACTION_DIGITS, TIME_FORMAT, TIMESTAMP_FORMAT, WILDCARD_CHARACTER

Method Summary

Modifier and Type	Method and Description
boolean	columnHasDefaultValue()
boolean	equals(java.lang.Object obj)
java.lang.Object	fetchValue(java.sql.ResultSet resultSet, int index) Fetches a value for this property from a ResultSet
java.lang.Object	fromColumnValue(java.lang.Object object)
AuditProperty.AuditAction	getAuditAction()
java.lang.String	getBeanProperty()
java.lang.String	getCaption()
java.lang.String	getColumnName()
int	getColumnType()
java.lang.String	getDateTimeFormatPattern()
java.time.format.DateTimeFormatter	getDateTimeFormatter()
java.lang.Object	getDefaultValue()
java.lang.String	getDescription()
java.lang.String	getEntityId()
ForeignKeyProperty	getForeignKeyProperty()
java.text.Format	getFormat()
java.lang.Double	getMax()
int	getMaximumFractionDigits()
int	getMaxLength()
java.lang.Double	getMin()
java.lang.Character	getMnemonic()
int	getPreferredColumnWidth()
int	getPrimaryKeyIndex()
java.lang.String	getPropertyId() The property identifier, should be unique within an Entity.
ResultPacker<java.lang.Object>	getResultPacker()
int	getType()
java.lang.Class	getTypeClass()
protected static java.lang.Class	getTypeClass(int sqlType)
boolean	hasDefaultValue()
int	hashCode()
boolean	is(Property property)
boolean	is(java.lang.String propertyId)
boolean	isAggregateColumn()
boolean	isBigDecimal()
boolean	isBoolean()
boolean	isCharacter()
boolean	isDate()
boolean	isDecimal()
boolean	isDenormalized()
boolean	isDouble()
boolean	isForeignKeyProperty()
boolean	isGroupingColumn()
boolean	isHidden()
boolean	isInteger()
boolean	isLong()
boolean	isNullable()
boolean	isNumerical()
boolean	isPrimaryKeyProperty()
boolean	isReadOnly() Specifies whether or not this attribute is read only
boolean	isSelectable()
boolean	isString()
boolean	isTemporal()
boolean	isTime()
boolean	isTimestamp()
boolean	isType(int type)
boolean	isUpdatable() Indicates whether or not this column is updatable
protected void	setReadOnly(boolean readOnly)
protected void	setUpdatable(boolean updatable)
java.lang.Object	toColumnValue(java.lang.Object value) Translates the given value into a sql value, usually this is not required but for certain types this may be necessary, such as boolean values represented by a non-boolean data type in the underlying database
java.lang.String	toString()
void	validateType(java.lang.Object value)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jminor.framework.domain.property.AuditProperty

getAuditAction

Methods inherited from interface org.jminor.framework.domain.property.ColumnProperty

columnHasDefaultValue, fetchValue, fromColumnValue, getColumnName, getColumnType, getForeignKeyProperty, getPrimaryKeyIndex, getResultPacker, isAggregateColumn, isDenormalized, isForeignKeyProperty, isGroupingColumn, isPrimaryKeyProperty, isSelectable, isUpdatable, toColumnValue

Methods inherited from interface org.jminor.framework.domain.property.Property

getBeanProperty, getCaption, getDateTimeFormatPattern, getDateTimeFormatter, getDefaultValue, getDescription, getEntityId, getFormat, getMax, getMaximumFractionDigits, getMaxLength, getMin, getMnemonic, getPreferredColumnWidth, getPropertyId, getType, getTypeClass, hasDefaultValue, is, is, isBigDecimal, isBoolean, isCharacter, isDate, isDecimal, isDouble, isHidden, isInteger, isLong, isNullable, isNumerical, isReadOnly, isString, isTemporal, isTime, isTimestamp, isType, validateType

Method Detail

getAuditAction

public final AuditProperty.AuditAction getAuditAction()

Specified by:

getAuditAction in interface AuditProperty

Returns:

the audit action this property represents

getColumnName

public final java.lang.String getColumnName()

Specified by:

getColumnName in interface ColumnProperty

Returns:

the column name

getColumnType

public final int getColumnType()

Specified by:

getColumnType in interface ColumnProperty

Returns:

the data type of the underlying column, usually the same as Property.getType() but can differ when the database system does not have native support for the given data type, such as boolean

toColumnValue

public final java.lang.Object toColumnValue(java.lang.Object value)

Translates the given value into a sql value, usually this is not required but for certain types this may be necessary, such as boolean values represented by a non-boolean data type in the underlying database

Specified by:

toColumnValue in interface ColumnProperty

Parameters:

value - the value to translate

Returns:

the sql value used to represent the given value

fromColumnValue

public final java.lang.Object fromColumnValue(java.lang.Object object)

Specified by:

fromColumnValue in interface ColumnProperty

Parameters:

object - the SQL value Object to translate from

Returns:

the value of SQL value

columnHasDefaultValue

public final boolean columnHasDefaultValue()

Specified by:

columnHasDefaultValue in interface ColumnProperty

Returns:

true if the underlying column has a default value

isUpdatable

public final boolean isUpdatable()

Indicates whether or not this column is updatable

Specified by:

isUpdatable in interface ColumnProperty

Returns:

true if this column is updatable

isDenormalized

public boolean isDenormalized()

Specified by:

isDenormalized in interface ColumnProperty

Returns:

true if this column is a denormalized column, one should which receives a value from a column in a table referenced via a foreign key

getPrimaryKeyIndex

public final int getPrimaryKeyIndex()

Specified by:

getPrimaryKeyIndex in interface ColumnProperty

Returns:

this propertys zero based index in the primary key, -1 if this property is not part of a primary key

isGroupingColumn

public final boolean isGroupingColumn()

Specified by:

isGroupingColumn in interface ColumnProperty

Returns:

true if this column is a group by column

isAggregateColumn

public final boolean isAggregateColumn()

Specified by:

isAggregateColumn in interface ColumnProperty

Returns:

true if this is an aggregate column

isSelectable

public final boolean isSelectable()

Specified by:

isSelectable in interface ColumnProperty

Returns:

true if this property should be included in select queries

getForeignKeyProperty

public final ForeignKeyProperty getForeignKeyProperty()

Specified by:

getForeignKeyProperty in interface ColumnProperty

Returns:

the ForeignKeyProperty this property is part of, if any

isForeignKeyProperty

public final boolean isForeignKeyProperty()

Specified by:

isForeignKeyProperty in interface ColumnProperty

Returns:

true if this property is part of a ForeignKeyProperty

isPrimaryKeyProperty

public final boolean isPrimaryKeyProperty()

Specified by:

isPrimaryKeyProperty in interface ColumnProperty

Returns:

true if this property is part of a primary key

isReadOnly

public final boolean isReadOnly()

Specifies whether or not this attribute is read only

Specified by:

isReadOnly in interface Property

Returns:

true if this attribute is read only

getCaption

public final java.lang.String getCaption()

Specified by:

getCaption in interface Property

Returns:

the caption

fetchValue

public final java.lang.Object fetchValue(java.sql.ResultSet resultSet,
                                         int index)
                                  throws java.sql.SQLException

Fetches a value for this property from a ResultSet

Specified by:

fetchValue in interface ColumnProperty

Parameters:

resultSet - the ResultSet

index - the index of the column to fetch

Returns:

a single value fetched from the given ResultSet

Throws:

java.sql.SQLException - in case of an exception

getResultPacker

public final ResultPacker<java.lang.Object> getResultPacker()

Specified by:

getResultPacker in interface ColumnProperty

Returns:

a ResultPacker responsible for packing this property

setUpdatable

protected void setUpdatable(boolean updatable)

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object

is

public final boolean is(java.lang.String propertyId)

Specified by:

is in interface Property

Parameters:

propertyId - the property ID

Returns:

true if this property is of the given type

is

public final boolean is(Property property)

Specified by:

is in interface Property

Parameters:

property - the property

Returns:

true if this property is of the given type

isNumerical

public final boolean isNumerical()

Specified by:

isNumerical in interface Property

Returns:

true if this is a numerical Property, that is, Integer or Double

isTemporal

public final boolean isTemporal()

Specified by:

isTemporal in interface Property

Returns:

true if this is a time based property, Date (LocalDate), Timestamp (LocalDatetime) or Time (LocalTime)

isDate

public final boolean isDate()

Specified by:

isDate in interface Property

Returns:

true if this is a date property

isTimestamp

public final boolean isTimestamp()

Specified by:

isTimestamp in interface Property

Returns:

true if this is a timestamp property

isTime

public final boolean isTime()

Specified by:

isTime in interface Property

Returns:

true if this is a time property

isCharacter

public final boolean isCharacter()

Specified by:

isCharacter in interface Property

Returns:

true if this is a character property

isString

public final boolean isString()

Specified by:

isString in interface Property

Returns:

true if this is a string property

isLong

public final boolean isLong()

Specified by:

isLong in interface Property

Returns:

true if this is a long property

isInteger

public final boolean isInteger()

Specified by:

isInteger in interface Property

Returns:

true if this is a integer property

isDouble

public final boolean isDouble()

Specified by:

isDouble in interface Property

Returns:

true if this is a double property

isBigDecimal

public final boolean isBigDecimal()

Specified by:

isBigDecimal in interface Property

Returns:

true if this is a BigDecimal property

isDecimal

public final boolean isDecimal()

Specified by:

isDecimal in interface Property

Returns:

true if this is a decimal property

isBoolean

public final boolean isBoolean()

Specified by:

isBoolean in interface Property

Returns:

true if this is a boolean property

getPropertyId

public final java.lang.String getPropertyId()

The property identifier, should be unique within an Entity. By default this id serves as column name for database properties.

Specified by:

getPropertyId in interface Property

Returns:

the id of this property

getEntityId

public java.lang.String getEntityId()

Specified by:

getEntityId in interface Property

Returns:

the id of the entity this property is associated with

getType

public final int getType()

Specified by:

getType in interface Property

Returns:

the data type (Types) of the value of this property

isType

public final boolean isType(int type)

Specified by:

isType in interface Property

Parameters:

type - the type to check (Types)

Returns:

true if the type of this property is the one given

getBeanProperty

public final java.lang.String getBeanProperty()

Specified by:

getBeanProperty in interface Property

Returns:

the bean property name associated with this property

isHidden

public final boolean isHidden()

Specified by:

isHidden in interface Property

Returns:

true if this property should be hidden in table views

hasDefaultValue

public boolean hasDefaultValue()

Specified by:

hasDefaultValue in interface Property

Returns:

true if a default value has been set for this property

getDefaultValue

public final java.lang.Object getDefaultValue()

Specified by:

getDefaultValue in interface Property

Returns:

the default value for this property, if no default value has been set null is returned

See Also:

Property.hasDefaultValue()

isNullable

public boolean isNullable()

Specified by:

isNullable in interface Property

Returns:

true if values associated with this property can be set null

getMaxLength

public final int getMaxLength()

Specified by:

getMaxLength in interface Property

Returns:

the maximum length of this property value, -1 is returned if the max length is undefined, this applies to String (varchar) based properties

getMax

public final java.lang.Double getMax()

Specified by:

getMax in interface Property

Returns:

the maximum allowed value for this property, null if none is defined, only applicable to numerical properties

getMin

public final java.lang.Double getMin()

Specified by:

getMin in interface Property

Returns:

the minimum allowed value for this property, null if none is defined, only applicable to numerical properties

getPreferredColumnWidth

public final int getPreferredColumnWidth()

Specified by:

getPreferredColumnWidth in interface Property

Returns:

the preferred column width of this property in pixels when presented in a table, 0 if none has been specified

getDescription

public final java.lang.String getDescription()

Specified by:

getDescription in interface Property

Returns:

a String describing this attribute

getMnemonic

public final java.lang.Character getMnemonic()

Specified by:

getMnemonic in interface Property

Returns:

the mnemonic to use when creating a label for this property

getFormat

public final java.text.Format getFormat()

Specified by:

getFormat in interface Property

Returns:

the Format object used to format the value of properties when being presented

getDateTimeFormatPattern

public final java.lang.String getDateTimeFormatPattern()

Specified by:

getDateTimeFormatPattern in interface Property

Returns:

the date/time format pattern

getDateTimeFormatter

public final java.time.format.DateTimeFormatter getDateTimeFormatter()

Specified by:

getDateTimeFormatter in interface Property

Returns:

the DateTimeFormatter for this property or null if this is not a date/time based property

getMaximumFractionDigits

public final int getMaximumFractionDigits()

Specified by:

getMaximumFractionDigits in interface Property

Returns:

the maximum number of fraction digits to use for this property value, only applicable to properties based on Types.DOUBLE and Types.DECIMAL

equals

public final boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object

getTypeClass

public final java.lang.Class getTypeClass()

Specified by:

getTypeClass in interface Property

Returns:

the Class representing the values of this attribute

validateType

public void validateType(java.lang.Object value)

Specified by:

validateType in interface Property

Parameters:

value - the value to validate

setReadOnly

protected void setReadOnly(boolean readOnly)

getTypeClass

protected static java.lang.Class getTypeClass(int sqlType)

Parameters:

sqlType - the type

Returns:

the Class representing the given type