ObjectType (Dari: Database 3.3.402-xd0fdd6 API)

java.lang.Object
- com.psddev.dari.db.Record
- - com.psddev.dari.db.ObjectType

All Implemented Interfaces:

ObjectStruct, Recordable, com.psddev.dari.util.HtmlObject, BeanInfo, Cloneable, Comparable<Record>
```
@Recordable.LabelFields(value="name")
public class ObjectType
extends Record
implements ObjectStruct
```
Represents how the Records are structured.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ObjectType.AnnotationProcessor<A extends Annotation>` Represents a class that can manipulate a type.
`static interface`	`ObjectType.AnnotationProcessorClass` Specifies the class that can manipulate a type using the target annotation.
`static interface`	`ObjectType.PostProcessor` Processor for Recordable.TypePostProcessorClass.
`static class`	`ObjectType.Static` `ObjectType` utility methods.

Nested classes/interfaces inherited from interface com.psddev.dari.db.Recordable
Recordable.Abstract, Recordable.BeanProperty, Recordable.BootstrapFollowReferences, Recordable.BootstrapPackages, Recordable.BootstrapTypeMappable, Recordable.CollectionMaximum, Recordable.CollectionMinimum, Recordable.Denormalized, Recordable.DenormalizedFields, Recordable.DisplayName, Recordable.Embedded, Recordable.FieldCollectionMaximum, Recordable.FieldCollectionMinimum, Recordable.FieldDisplayName, Recordable.FieldEmbedded, Recordable.FieldGlobal, Recordable.FieldIgnored, Recordable.FieldIndexed, Recordable.FieldInternalName, Recordable.FieldInternalNamePrefix, Recordable.FieldItemTypes, Recordable.FieldMaximum, Recordable.FieldMinimum, Recordable.FieldPattern, Recordable.FieldRequired, Recordable.FieldStep, Recordable.FieldTypes, Recordable.FieldUnique, Recordable.FieldValues, Recordable.Groups, Recordable.Ignored, Recordable.IgnoredIfEmbedded, Recordable.Indexed, Recordable.InternalName, Recordable.JunctionField, Recordable.JunctionPositionField, Recordable.LabelFields, Recordable.Maximum, Recordable.MetricValue, Recordable.MimeTypes, Recordable.Minimum, Recordable.PreviewField, Recordable.Raw, Recordable.Recalculate, Recordable.Regex, Recordable.Required, Recordable.SourceDatabaseClass, Recordable.SourceDatabaseName, Recordable.SourceDatabaseProviderClass, Recordable.Step, Recordable.TypeId, Recordable.TypePostProcessorClasses, Recordable.Types, Recordable.TypesExclude, Recordable.Values, Recordable.Where

Field Summary
- Fields inherited from interface java.beans.BeanInfo
  ICON_COLOR_16x16, ICON_COLOR_32x32, ICON_MONO_16x16, ICON_MONO_32x32

Constructor Summary

Constructors
Constructor and Description

ObjectType()

Constructors
Constructor and Description
`ObjectType()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Object`	`createObject(UUID id)` Creates an object of this type with the given `id`.
`Set<ObjectType>`	`findConcreteTypes()` Finds a set of all the other concrete types that are compatible with this one.
`Set<String>`	`getAssignableClassNames()` Returns the list of class names whose instances can be assigned from the objects of this type.
`Class<?>`	`getAugmentationClass(Class<?> targetClass)`
`Map<String,Set<String>>`	`getAugmentationClassNamesByTargetClassName()`
`Set<String>`	`getDenormalizedFields()` Returns the set of all denormalized field names.
`String`	`getDisplayName()` Returns the display name.
`DatabaseEnvironment`	`getEnvironment()` Returns the environment that owns this struct.
`ObjectField`	`getField(String name)` Returns the field associated with the given `name` in this type.
`ObjectField`	`getFieldGlobally(String name)` Returns the field associated with the given `name` in this type or globally in all types.
`List<ObjectField>`	`getFields()` Returns a list of all fields.
`Set<String>`	`getGroups()` Returns the list of groups.
`ObjectIndex`	`getIndex(String name)` Returns the index with the given `name`.
`ObjectIndex`	`getIndexByFields(String... names)`
`List<ObjectField>`	`getIndexedFields()` Deprecated. Use `ObjectStruct.Static.findIndexedFields(com.psddev.dari.db.ObjectStruct)` instead.
`List<ObjectIndex>`	`getIndexes()` Returns a list of all the indexes.
`static ObjectType`	`getInstance(Class<?> objectClass)` Returns an instance with the given `objectClass`.
`static ObjectType`	`getInstance(String name)` Returns an instance with the given `name`.
`static ObjectType`	`getInstance(UUID id)` Returns an instance with the given `id`.
`String`	`getInternalName()` Returns the internal name.
`String`	`getJavaBeanProperty()`
`List<String>`	`getLabelFields()` Returns the list of field names that are combined to create labels for the objects of this type.
`ObjectMethod`	`getMethod(String name)` Returns the method associated with the given `name` in this type.
`List<ObjectMethod>`	`getMethods()` Returns all of the methods that Dari is aware of.
`List<ObjectField>`	`getMetricFields()`
`Set<String>`	`getModificationClassNames()` Returns the set of modification class names.
`Class<?>`	`getObjectClass()` Returns the class used to create objects of this type.
`String`	`getObjectClassName()` Returns name of the class used to create objects of this type.
`String`	`getPreviewField()` Returns the field name used to create the previews of the objects represented by this type.
`Database`	`getSourceDatabase()` Returns the source database.
`String`	`getSourceDatabaseClassName()` Returns the source database class name.
`String`	`getSourceDatabaseName()` Returns the source database name.
`String`	`getSourceDatabaseProviderClassName()`
`List<String>`	`getSuperClassNames()` Returns the list of super class names.
`void`	`initialize()` Initializes this type definition with the reflection data from the object class of this type.
`boolean`	`isAbstract()` Returns `true` if the objects of this type cannot be created.
`boolean`	`isConcrete()` Returns `true` if the objects of this type can be saved to the database.
`boolean`	`isDenormalized()` Returns `true` if the objects of this type is always denormalized within other objects.
`boolean`	`isDeprecated()`
`boolean`	`isEmbedded()` Returns `true` if the objects of this type can only be embedded within other objects.
`boolean`	`isInstantiableTo(Class<?> targetClass)` Returns `true` if this type can be converted into an instance of the given `targetClass`.
`boolean`	`isLazyLoaded()`
`boolean`	`isMethod(String name)` Returns whether the given `name` is an ObjectMethod in this type.
`void`	`modify(Class<?> modificationClass)` Modifies this type definition with the reflection data from the given `modificationClass`.
`static void`	`modifyAll(Database database, Class<?> modificationClass)` Modifies all the type definitions with the reflection data from the given `modificationClass`.
`void`	`setAbstract(boolean isAbstract)` Sets whether the objects of this type cannot be created.
`void`	`setAssignableClassNames(Set<String> assignableClassNames)` Sets the list of class names whose instances can be assigned from the objects of this type.
`void`	`setAugmentationClassNamesByTargetClassName(Map<String,Set<String>> augmentationClassNamesByTargetClassName)`
`void`	`setDenormalized(boolean denormalized)` Sets whether the objects of this type is always denormalized within other objects.
`void`	`setDenormalizedFields(Set<String> denormalizedFields)` Sets the set of all denormalized field names.
`void`	`setDeprecated(boolean deprecated)`
`void`	`setDisplayName(String displayName)` Sets the display name.
`void`	`setEmbedded(boolean isEmbedded)` Sets whether the objects of this type can only be embedded within other objects.
`void`	`setFields(List<ObjectField> fields)` Sets the list of all fields.
`void`	`setGroups(Set<String> groups)` Sets the list of groups.
`void`	`setIndexes(List<ObjectIndex> indexes)` Sets the list of all indexes.
`void`	`setInternalName(String internalName)` Sets the internal name.
`void`	`setJavaBeanProperty(String javaBeanProperty)`
`void`	`setLabelFields(List<String> fields)` Sets the list of field names that are combined to create labels for the objects of this type.
`void`	`setModificationClasses(Set<String> modificationClasses)` Sets the set of modification class names.
`void`	`setObjectClassName(String objectClassName)` Sets name of the class used to create objects of this type.
`void`	`setPreviewField(String field)` Sets the field name used to create the previews of the objects represented by this type.
`void`	`setSourceDatabaseClassName(String sourceDatabaseClassName)` Sets the source database class name.
`void`	`setSourceDatabaseName(String sourceDatabaseName)` Sets the source database name.
`void`	`setSourceDatabaseProviderClassName(String sourceDatabaseProviderClassName)`
`void`	`setSuperClassNames(List<String> superClassNames)` Sets the list of super class names.

Methods inherited from class com.psddev.dari.db.Record
afterCreate, afterDelete, afterDelete, afterSave, afterSave, beforeCommit, beforeDelete, beforeDelete, beforeSave, beforeSave, beginWrites, clone, commitWrites, compareTo, delete, endWrites, equals, format, getAdditionalBeanInfo, getAs, getBeanDescriptor, getDefaultEventIndex, getDefaultPropertyIndex, getEventSetDescriptors, getExtra, getIcon, getId, getLabel, getMethodDescriptors, getModifications, getPropertyDescriptors, getState, hashCode, is, is, onDuplicate, onValidate, queryFrom, receiveMessage, save, saveEventually, saveImmediately, saveUniquely, sendMessage, setState, toString

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.psddev.dari.db.ObjectStruct
findIndexedFields

Methods inherited from interface com.psddev.dari.db.Recordable
as

- Constructor Detail
  - ObjectType
```
public ObjectType()
```
- Method Detail
  - modifyAll
```
public static void modifyAll(Database database,
                             Class<?> modificationClass)
```
    Modifies all the type definitions with the reflection data from the given modificationClass.
  - getDisplayName
```
public String getDisplayName()
```
    Returns the display name.
  - setDisplayName
```
public void setDisplayName(String displayName)
```
    Sets the display name.
  - getInternalName
```
public String getInternalName()
```
    Returns the internal name.
  - setInternalName
```
public void setInternalName(String internalName)
```
    Sets the internal name.
  - getLabelFields
```
public List<String> getLabelFields()
```
    Returns the list of field names that are combined to create labels for the objects of this type.
  - setLabelFields
```
public void setLabelFields(List<String> fields)
```
    Sets the list of field names that are combined to create labels for the objects of this type.
  - getPreviewField
```
public String getPreviewField()
```
    Returns the field name used to create the previews of the objects represented by this type.
  - setPreviewField
```
public void setPreviewField(String field)
```
    Sets the field name used to create the previews of the objects represented by this type.
  - isDeprecated
```
public boolean isDeprecated()
```
  - setDeprecated
```
public void setDeprecated(boolean deprecated)
```
  - isAbstract
```
public boolean isAbstract()
```
    Returns true if the objects of this type cannot be created.
  - setAbstract
```
public void setAbstract(boolean isAbstract)
```
    Sets whether the objects of this type cannot be created.
  - isEmbedded
```
public boolean isEmbedded()
```
    Returns true if the objects of this type can only be embedded within other objects.
  - setEmbedded
```
public void setEmbedded(boolean isEmbedded)
```
    Sets whether the objects of this type can only be embedded within other objects.
  - isDenormalized
```
public boolean isDenormalized()
```
    Returns true if the objects of this type is always denormalized within other objects.
  - setDenormalized
```
public void setDenormalized(boolean denormalized)
```
    Sets whether the objects of this type is always denormalized within other objects.
  - getDenormalizedFields
```
public Set<String> getDenormalizedFields()
```
    Returns the set of all denormalized field names.
  - setDenormalizedFields
```
public void setDenormalizedFields(Set<String> denormalizedFields)
```
    Sets the set of all denormalized field names.
  - isConcrete
```
@Recordable.Indexed
public boolean isConcrete()
```
    Returns true if the objects of this type can be saved to the database.
  - getGroups
```
public Set<String> getGroups()
```
    Returns the list of groups.
  - setGroups
```
public void setGroups(Set<String> groups)
```
    Sets the list of groups.
  - getEnvironment
```
public DatabaseEnvironment getEnvironment()
```
    Description copied from interface: ObjectStruct
    
    Returns the environment that owns this struct.
    
    Specified by:
    
    getEnvironment in interface ObjectStruct
    
    Returns:
    
    Never null.
  - getFields
```
public List<ObjectField> getFields()
```
    Returns a list of all fields.
    
    Specified by:
    
    getFields in interface ObjectStruct
    
    Returns:
    
    Never null.
  - setFields
```
public void setFields(List<ObjectField> fields)
```
    Sets the list of all fields.
    
    Specified by:
    
    setFields in interface ObjectStruct
    
    Parameters:
    
    fields - null to clear.
  - getMetricFields
```
public List<ObjectField> getMetricFields()
```
  - getField
```
public ObjectField getField(String name)
```
    Returns the field associated with the given name in this type.
    
    Specified by:
    
    getField in interface ObjectStruct
    
    Parameters:
    
    name - If null, returns null.
    
    Returns:
    
    May be null.
  - getMethod
```
public ObjectMethod getMethod(String name)
```
    Returns the method associated with the given name in this type.
    
    Parameters:
    
    name - If null, returns null.
    
    Returns:
    
    May be null.
  - getMethods
```
public List<ObjectMethod> getMethods()
```
    Returns all of the methods that Dari is aware of.
  - isMethod
```
public boolean isMethod(String name)
```
    Returns whether the given name is an ObjectMethod in this type.
    
    Parameters:
    
    name - If null, returns false.
  - getFieldGlobally
```
public ObjectField getFieldGlobally(String name)
```
    Returns the field associated with the given name in this type or globally in all types.
    
    Parameters:
    
    name - If null, returns null.
    
    Returns:
    
    May be null.
  - getIndexedFields
```
@Deprecated
public List<ObjectField> getIndexedFields()
```
    Deprecated. Use ObjectStruct.Static.findIndexedFields(com.psddev.dari.db.ObjectStruct) instead.
    
    Returns all fields that are indexed.
  - getIndexes
```
public List<ObjectIndex> getIndexes()
```
    Returns a list of all the indexes.
    
    Specified by:
    
    getIndexes in interface ObjectStruct
    
    Returns:
    
    Never null.
  - getIndexByFields
```
public ObjectIndex getIndexByFields(String... names)
```
  - setIndexes
```
public void setIndexes(List<ObjectIndex> indexes)
```
    Sets the list of all indexes.
    
    Specified by:
    
    setIndexes in interface ObjectStruct
    
    Parameters:
    
    indexes - null to clear.
  - getIndex
```
public ObjectIndex getIndex(String name)
```
    Returns the index with the given name.
    
    Specified by:
    
    getIndex in interface ObjectStruct
    
    Parameters:
    
    name - If null, returns null.
    
    Returns:
    
    May be null.
  - getObjectClassName
```
public String getObjectClassName()
```
    Returns name of the class used to create objects of this type.
  - setObjectClassName
```
public void setObjectClassName(String objectClassName)
```
    Sets name of the class used to create objects of this type.
  - getObjectClass
```
public Class<?> getObjectClass()
```
    Returns the class used to create objects of this type.
  - getSourceDatabaseClassName
```
public String getSourceDatabaseClassName()
```
    Returns the source database class name.
  - setSourceDatabaseClassName
```
public void setSourceDatabaseClassName(String sourceDatabaseClassName)
```
    Sets the source database class name.
  - getSourceDatabaseName
```
public String getSourceDatabaseName()
```
    Returns the source database name.
  - setSourceDatabaseName
```
public void setSourceDatabaseName(String sourceDatabaseName)
```
    Sets the source database name.
  - getSourceDatabaseProviderClassName
```
public String getSourceDatabaseProviderClassName()
```
  - setSourceDatabaseProviderClassName
```
public void setSourceDatabaseProviderClassName(String sourceDatabaseProviderClassName)
```
  - getSourceDatabase
```
public Database getSourceDatabase()
```
    Returns the source database.
    
    Returns:
    
    May be null.
  - getJavaBeanProperty
```
public String getJavaBeanProperty()
```
  - setJavaBeanProperty
```
public void setJavaBeanProperty(String javaBeanProperty)
```
  - getModificationClassNames
```
public Set<String> getModificationClassNames()
```
    Returns the set of modification class names.
  - setModificationClasses
```
public void setModificationClasses(Set<String> modificationClasses)
```
    Sets the set of modification class names.
  - getSuperClassNames
```
public List<String> getSuperClassNames()
```
    Returns the list of super class names.
  - setSuperClassNames
```
public void setSuperClassNames(List<String> superClassNames)
```
    Sets the list of super class names.
  - getAssignableClassNames
```
public Set<String> getAssignableClassNames()
```
    Returns the list of class names whose instances can be assigned from the objects of this type.
  - setAssignableClassNames
```
public void setAssignableClassNames(Set<String> assignableClassNames)
```
    Sets the list of class names whose instances can be assigned from the objects of this type.
  - getAugmentationClassNamesByTargetClassName
```
public Map<String,Set<String>> getAugmentationClassNamesByTargetClassName()
```
  - setAugmentationClassNamesByTargetClassName
```
public void setAugmentationClassNamesByTargetClassName(Map<String,Set<String>> augmentationClassNamesByTargetClassName)
```
  - getAugmentationClass
```
public Class<?> getAugmentationClass(Class<?> targetClass)
```
  - isLazyLoaded
```
public boolean isLazyLoaded()
```
  - initialize
```
public void initialize()
```
    Initializes this type definition with the reflection data from the object class of this type.
  - modify
```
public void modify(Class<?> modificationClass)
```
    Modifies this type definition with the reflection data from the given modificationClass.
  - findConcreteTypes
```
public Set<ObjectType> findConcreteTypes()
```
    Finds a set of all the other concrete types that are compatible with this one.
  - getInstance
```
public static ObjectType getInstance(UUID id)
```
    Returns an instance with the given id.
  - getInstance
```
public static ObjectType getInstance(String name)
```
    Returns an instance with the given name.
  - getInstance
```
public static ObjectType getInstance(Class<?> objectClass)
```
    Returns an instance with the given objectClass.
  - createObject
```
public Object createObject(UUID id)
```
    Creates an object of this type with the given id.
  - isInstantiableTo
```
public boolean isInstantiableTo(Class<?> targetClass)
```
    Returns true if this type can be converted into an instance of the given targetClass.
    
    Specified by:
    
    isInstantiableTo in interface Recordable
    
    Parameters:
    
    targetClass - non-null.
    
    See Also:
    
    State.isInstantiableTo(Class)

Class ObjectType

Nested Class Summary

Nested classes/interfaces inherited from interface com.psddev.dari.db.Recordable

Field Summary

Fields inherited from interface java.beans.BeanInfo

Constructor Summary

Method Summary

Methods inherited from class com.psddev.dari.db.Record

Methods inherited from class java.lang.Object

Methods inherited from interface com.psddev.dari.db.ObjectStruct

Methods inherited from interface com.psddev.dari.db.Recordable

Constructor Detail

ObjectType

Method Detail

modifyAll

getDisplayName

setDisplayName

getInternalName

setInternalName

getLabelFields

setLabelFields

getPreviewField

setPreviewField

isDeprecated

setDeprecated

isAbstract

setAbstract

isEmbedded

setEmbedded

isDenormalized

setDenormalized

getDenormalizedFields

setDenormalizedFields

isConcrete

getGroups

setGroups

getEnvironment

getFields

setFields

getMetricFields

getField

getMethod

getMethods

isMethod

getFieldGlobally

getIndexedFields

getIndexes

getIndexByFields

setIndexes

getIndex

getObjectClassName

setObjectClassName

getObjectClass

getSourceDatabaseClassName

setSourceDatabaseClassName

getSourceDatabaseName

setSourceDatabaseName

getSourceDatabaseProviderClassName

setSourceDatabaseProviderClassName

getSourceDatabase

getJavaBeanProperty

setJavaBeanProperty

getModificationClassNames

setModificationClasses

getSuperClassNames

setSuperClassNames

getAssignableClassNames

setAssignableClassNames

getAugmentationClassNamesByTargetClassName

setAugmentationClassNamesByTargetClassName

getAugmentationClass

isLazyLoaded

initialize

modify

findConcreteTypes

getInstance

getInstance

getInstance

createObject

isInstantiableTo