|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Property
Specifies a Property.
Nested Class Summary | |
---|---|
static interface |
Property.AuditProperty
A property representing an audit column |
static interface |
Property.AuditTimeProperty
Specifiesa audit property with a timestamp value |
static interface |
Property.AuditUserProperty
Specifiesa audit property with a username value |
static interface |
Property.BlobProperty
A BLOB property, based on two columns, the actual BLOB column and a column containing the name of the BLOB object. |
static interface |
Property.BooleanProperty
A boolean property, with special handling since different values are used for representing boolean values in different systems |
static interface |
Property.ColumnProperty
Specifies a property based on a table column |
static interface |
Property.DenormalizedProperty
A property representing a column that should get its value automatically from a column in a referenced table |
static interface |
Property.DenormalizedViewProperty
A property that gets its value from a entity referenced by a foreign key, but is for display only, and does not map to a database column |
static interface |
Property.DerivedProperty
A property which value is derived from the values of one or more properties. |
static interface |
Property.ForeignKeyProperty
A wrapper property that represents a reference to another entity, typically but not necessarily based on a foreign key. |
static interface |
Property.MirrorProperty
Represents a child foreign key property that is already included as part of another reference foreign key property, and should not handle updating the underlying property, useful in rare cases when foreign keys are referencing tables having composite natural primary keys as opposed to surrogate ones. |
static interface |
Property.PrimaryKeyProperty
A property that is part of a entities primary key. |
static interface |
Property.SearchableProperty
Specifies a property that can be include in database search criteria |
static interface |
Property.SubqueryProperty
A property based on a subquery, returning a single value |
static interface |
Property.TransientProperty
A property that does not map to an underlying database column. |
static interface |
Property.ValueListProperty
A property based on a list of values, each with a displayable caption. |
Method Summary | |
---|---|
Object |
getDefaultValue()
|
String |
getEntityID()
|
Format |
getFormat()
|
Double |
getMax()
|
int |
getMaximumFractionDigits()
|
int |
getMaxLength()
|
Double |
getMin()
|
Character |
getMnemonic()
|
Property.ForeignKeyProperty |
getParentProperty()
|
int |
getPreferredColumnWidth()
|
String |
getPropertyID()
The property identifier, should be unique within an Entity. |
int |
getType()
|
boolean |
hasParentProperty()
|
boolean |
is(Property property)
|
boolean |
is(String propertyID)
|
boolean |
isBoolean()
|
boolean |
isCharacter()
|
boolean |
isDate()
|
boolean |
isDouble()
|
boolean |
isHidden()
|
boolean |
isInteger()
|
boolean |
isNullable()
|
boolean |
isNumerical()
|
boolean |
isReadOnly()
Specifies whether or not this attribute is read only |
boolean |
isString()
|
boolean |
isTime()
|
boolean |
isTimestamp()
|
boolean |
isType(int type)
|
Property |
setDefaultValue(Object defaultValue)
Sets the default value for this property, overrides the underlying column default value, if any |
Property |
setDescription(String description)
|
void |
setEntityID(String entityID)
|
Property |
setFormat(Format format)
Sets the Format to use when presenting property values |
Property |
setHidden(boolean hidden)
|
Property |
setMax(double max)
Sets the maximum allowed value for this property, only applicable to numerical properties |
Property |
setMaximumFractionDigits(int maximumFractionDigits)
Sets the maximum fraction digits to show for this property, only applicable to DOUBLE properties This setting is overridden during subsquence calls to setFormat |
Property |
setMaxLength(int maxLength)
Sets the maximum length of this property value, this applies to String (varchar) based properties |
Property |
setMin(double min)
Only applicable to numerical properties |
Property |
setMnemonic(Character mnemonic)
Sets the mnemonic to use when creating a label for this property |
Property |
setNullable(boolean nullable)
Specifies whether or not this property is nullable, in case of properties that have parent properties (properties which comprise a fk property fx) inherit the nullable state of the parent property. |
void |
setParentProperty(Property.ForeignKeyProperty foreignKeyProperty)
|
Property |
setPreferredColumnWidth(int preferredColumnWidth)
|
Property |
setReadOnly(boolean readOnly)
|
Property |
setUseNumberFormatGrouping(boolean useGrouping)
Specifies whether to use number grouping when presenting this value. |
Methods inherited from interface org.jminor.common.model.Attribute |
---|
getCaption, getDescription, getTypeClass, hasDescription |
Method Detail |
---|
String getEntityID()
void setEntityID(String entityID)
entityID
- the ID of the entity this property is associated with
IllegalStateException
- in case the entityID has already been setString getPropertyID()
boolean is(String propertyID)
propertyID
- the property ID
boolean is(Property property)
property
- the property
int getType()
boolean isType(int type)
type
- the type to check
boolean isNumerical()
boolean isTime()
boolean isDate()
boolean isTimestamp()
boolean isCharacter()
boolean isString()
boolean isInteger()
boolean isDouble()
boolean isBoolean()
Property setDefaultValue(Object defaultValue)
defaultValue
- the value to use as default
Object getDefaultValue()
boolean isHidden()
Property setHidden(boolean hidden)
hidden
- specifies whether this property should hidden in table views
Double getMax()
Property setMax(double max)
max
- the maximum allowed value
Double getMin()
Property setMin(double min)
min
- the minimum allowed value for this property
Property setMaximumFractionDigits(int maximumFractionDigits)
setFormat
maximumFractionDigits
- the maximum fraction digits
int getMaximumFractionDigits()
Property setUseNumberFormatGrouping(boolean useGrouping)
setFormat
useGrouping
- if true then number grouping is used
int getPreferredColumnWidth()
Property setPreferredColumnWidth(int preferredColumnWidth)
preferredColumnWidth
- the preferred column width to be used when this property is shown in a table
Property setReadOnly(boolean readOnly)
readOnly
- specifies whether this property should be included during insert/update operations
Property setNullable(boolean nullable)
nullable
- specifies whether or not this property accepts a null value
boolean isNullable()
Property setMaxLength(int maxLength)
maxLength
- the maximum length
int getMaxLength()
Character getMnemonic()
Property setMnemonic(Character mnemonic)
mnemonic
- the mnemonic character
Property setDescription(String description)
description
- a String describing this property
Format getFormat()
Property setFormat(Format format)
format
- the format to use
boolean isReadOnly()
boolean hasParentProperty()
void setParentProperty(Property.ForeignKeyProperty foreignKeyProperty)
foreignKeyProperty
- the parent foreign key property, if anyProperty.ForeignKeyProperty getParentProperty()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |