Package net.java.ao.schema.info
Interface FieldInfo<T>
- Type Parameters:
T
-
public interface FieldInfo<T>
A description of the field generated by the
RawEntity
- Since:
- 0.21
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionA predicate for filtering fields with value generatorsA predicate for filtering required fieldsReturn the name of the field -
Method Summary
Modifier and TypeMethodDescriptionClass<? extends ValueGenerator<? extends T>>
getName()
boolean
boolean
boolean
boolean
boolean
Deprecated.since 0.25.boolean
boolean
boolean
boolean
-
Field Details
-
IS_REQUIRED
A predicate for filtering required fields- See Also:
-
HAS_GENERATOR
A predicate for filtering fields with value generators- See Also:
-
PLUCK_NAME
Return the name of the field
-
-
Method Details
-
getName
String getName()- Returns:
- the name of the column in the database.
-
getPolymorphicName
String getPolymorphicName()- Returns:
- the polymorphic name for the field, if one exists
- See Also:
-
isPrimary
boolean isPrimary()- Returns:
true
if the field is the primary key,false
otherwise- See Also:
-
isNullable
boolean isNullable()- Returns:
true
if the field is nullable,false
otherwise- See Also:
-
isStorable
boolean isStorable()- Returns:
true
if a value corresponding to this field may be stored by the entity,false
otherwise
-
isCacheable
boolean isCacheable()Deprecated.since 0.25. Entities and values now no longer cached. -
isTransient
boolean isTransient()- Returns:
true
if the field is transient,false
otherwise- See Also:
-
hasAutoIncrement
boolean hasAutoIncrement()- Returns:
true
if the field an auto increment field,false
otherwise- See Also:
-
hasDefaultValue
boolean hasDefaultValue()- Returns:
true
if the field has a default value,false
otherwise
-
getTypeInfo
- Returns:
- The database type information for the field
-
getJavaType
- Returns:
- the java type of the field
-
hasAccessor
boolean hasAccessor()- Returns:
true
if the field has an accessor,false
otherwise
-
getAccessor
Method getAccessor()- Returns:
- the accessor if one exists
- See Also:
-
hasMutator
boolean hasMutator()- Returns:
true
if the field has an mutator,false
otherwise
-
getMutator
Method getMutator()- Returns:
- the mutator if one exists
- See Also:
-
getGeneratorType
Class<? extends ValueGenerator<? extends T>> getGeneratorType()- Returns:
- the class of the value generator if one exists
- See Also:
-