Package adalid.core
Class EntityCollection
- java.lang.Object
-
- adalid.core.AbstractArtifact
-
- adalid.core.EntityCollection
-
- All Implemented Interfaces:
Wrappable,AnnotatableArtifact,Artifact
public class EntityCollection extends AbstractArtifact implements AnnotatableArtifact
- Author:
- Jorge Campins
-
-
Field Summary
-
Fields inherited from class adalid.core.AbstractArtifact
ENGLISH, NBSP, PORTUGUESE, SPANISH
-
-
Constructor Summary
Constructors Constructor Description EntityCollection()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description EntityCollectionAggregateaddAverage(String fieldName, NumericExpression minimum)EntityCollectionAggregateaddAverage(String fieldName, NumericExpression minimum, NumericExpression maximum)EntityCollectionAggregateaddAverage(String fieldName, NumericExpression minimum, Number maximum)EntityCollectionAggregateaddAverage(String fieldName, Number minimum)EntityCollectionAggregateaddAverage(String fieldName, Number minimum, NumericExpression maximum)EntityCollectionAggregateaddAverage(String fieldName, Number minimum, Number maximum)EntityCollectionAggregateaddCount(int minimum)EntityCollectionAggregateaddCount(int minimum, int maximum)EntityCollectionAggregateaddCount(int minimum, NumericExpression maximum)EntityCollectionAggregateaddCount(NumericExpression minimum)EntityCollectionAggregateaddCount(NumericExpression minimum, int maximum)EntityCollectionAggregateaddCount(NumericExpression minimum, NumericExpression maximum)EntityCollectionAggregateaddCount(String fieldName, int minimum)EntityCollectionAggregateaddCount(String fieldName, int minimum, int maximum)EntityCollectionAggregateaddCount(String fieldName, int minimum, NumericExpression maximum)EntityCollectionAggregateaddCount(String fieldName, NumericExpression minimum)EntityCollectionAggregateaddCount(String fieldName, NumericExpression minimum, int maximum)EntityCollectionAggregateaddCount(String fieldName, NumericExpression minimum, NumericExpression maximum)EntityCollectionAggregateaddSum(String fieldName, NumericExpression minimum)EntityCollectionAggregateaddSum(String fieldName, NumericExpression minimum, NumericExpression maximum)EntityCollectionAggregateaddSum(String fieldName, NumericExpression minimum, Number maximum)EntityCollectionAggregateaddSum(String fieldName, Number minimum)EntityCollectionAggregateaddSum(String fieldName, Number minimum, NumericExpression maximum)EntityCollectionAggregateaddSum(String fieldName, Number minimum, Number maximum)booleanfinalise()dot the i's and cross the t'sList<EntityCollectionAggregate>getAggregatesList()CascadeType[]getCascadeType()StringgetCascadeTypeString()DataEntryFormatgetDataEntryFormat()DisplaygetDetailDisplay()DisplaygetDisplay()DisplaygetExtensionDisplay(Entity extension)FetchTypegetFetchType()FieldgetMappedByField()StringgetMappedByFieldName()PropertygetMappedByProperty()PropertyAccessgetPropertyAccess()BooleanExpressiongetRenderingFilter()EntitygetSourceEntity()StepgetStep()TabgetTab()DisplaygetTableDisplay()EntitygetTargetEntity()ClassgetTargetEntityClass()protected List<Class<? extends Annotation>>getValidFieldAnnotations()booleanisAuditable()booleanisCascadeMerge()booleanisCascadePersist()booleanisCascadeRefresh()booleanisCascadeRemove()booleanisCreateField()booleanisDetailField()booleanisEntityCollectionField()booleanisEntityCollectionWithDisplay()booleanisNullable()booleanisOneToMany()booleanisOrphanRemoval()booleanisRenderingFilterReadOnly()booleanisUpdateField()voidsetCascadeType(CascadeType... cascadeType)El método setCascadeType se utiliza para establecer el conjunto de operaciones que se propagan a la entidad relacionada.voidsetCreateField(boolean create)El método setCreateField se utiliza para establecer si la colección es, o no, requerida por la operación insert de las vistas (páginas) de registro.voidsetDataEntryFormat(DataEntryFormat format)El método setDataEntryFormat se utiliza para establecer el orden de búsqueda de la vista (página) para entrada de datos de la colección.voidsetDetailField(boolean detail)El método setDetailField se utiliza para establecer si la colección es, o no, visible en las vistas (páginas) de consulta y registro detallado.voidsetFetchType(FetchType fetchType)El método setFetchType se utiliza para establecer la estrategia para obtener datos de la base de datos.voidsetOrphanRemoval(boolean remove)El método setOrphanRemoval se utiliza para establecer si se aplica la operación de eliminación a las entidades que se han eliminado de la relación y si se conecta en cascada la operación de eliminación a esas entidades.voidsetPropertyAccess(PropertyAccess access)El método setPropertyAccess se utiliza para establecer el tipo de control de acceso de la colección.voidsetRenderingFilter(BooleanExpression renderingFilter)El método setRenderingFilter se utiliza para establecer el filtro de presentación de la colección en las vistas (páginas) de consulta y/o registro de la entidad.voidsetRenderingFilter(BooleanExpression renderingFilter, boolean readOnly)El método setRenderingFilter se utiliza para establecer el filtro de presentación de la colección en las vistas (páginas) de consulta y/o registro de la entidad.voidsetUpdateField(boolean update)El método setUpdateField se utiliza para establecer si la colección es, o no, requerida por la operación update de las vistas (páginas) de registro.-
Methods inherited from class adalid.core.AbstractArtifact
addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttributes, annotate, checkName, classToString, clearAttributes, coalesce, copyLocalizedStrings, defaultLocale, depth, fa, fieldsToString, getAlias, getAttribute, getAttribute, getAttributes, getAttributesArray, getAttributesArray, getAttributesKeySetByRegex, getBooleanAttribute, getBooleanAttribute, getClassPath, getDeclaringArtifact, getDeclaringEntity, getDeclaringEntityRoot, getDeclaringField, getDeclaringFieldEntityRoot, getDeclaringFieldIndex, getDeclaringFieldNamedClassSimpleName, getDeclaringFieldPersistentEntityRoot, getDeclaringFieldPersistentEntityTableRoot, getDeclaringOperation, getDeclaringPersistentEntity, getDeclaringPersistentEntityRoot, getDefaultCollectionLabel, getDefaultCollectionShortLabel, getDefaultDescription, getDefaultLabel, getDefaultLocale, getDefaultShortDescription, getDefaultShortLabel, getDefaultSymbol, getDefaultTooltip, getDefaultWrapperClass, getFullName, getIntegerAttribute, getIntegerAttribute, getIntegerAttribute, getIntegerAttribute, getKeyValuePairAttribute, getKeyValuePairAttribute, getKeyValuePairAttribute, getKeyValuePairAttribute, getLocalizedCollectionLabel, getLocalizedCollectionShortLabel, getLocalizedDescription, getLocalizedLabel, getLocalizedShortDescription, getLocalizedShortLabel, getLocalizedSymbol, getLocalizedTooltip, getName, getPartialName, getPathList, getPathString, getSqlName, getStringAttribute, getStringAttribute, getStringAttribute, getStringAttribute, getTrace, getValidTypeAnnotations, getValueString, getValueString, getWrapper, hashCodeHexString, isAnnotated, isClassInPath, isDeclared, isExpression, isFinalised, isFontAwesomeClass, isInherited, isInheritedFromAbstract, isInheritedFromConcrete, isLocalizedSymbolDefined, isNotDeclared, isNotInherited, isNotInheritedFromAbstract, isNotInheritedFromConcrete, isOperation, isValidEmbeddedDocument, isValidFieldAnnotation, isValidHelpFileName, isValidHelpFileType, isValidJavaClassName, isValidSnippetFileName, isValidTypeAnnotation, localeReadingKey, localeWritingKey, mapsToString, put, repeat, round, setAlias, setDefaultCollectionLabel, setDefaultCollectionShortLabel, setDefaultDescription, setDefaultLabel, setDefaultShortDescription, setDefaultShortLabel, setDefaultSymbol, setDefaultTooltip, setLocalizedCollectionLabel, setLocalizedCollectionShortLabel, setLocalizedDescription, setLocalizedLabel, setLocalizedShortDescription, setLocalizedShortLabel, setLocalizedSymbol, setLocalizedTooltip, setSqlName, setStaticAttributes, settler, setTrace, specified, specified, specified, specified, specified, specified, toString, toString, toString, toString, toString, verifyExpression, verifyExpression, verifyExpression, verifyExpression, verifyExpression, verifyExpression, verifyNames
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface adalid.core.interfaces.AnnotatableArtifact
annotate
-
Methods inherited from interface adalid.core.interfaces.Artifact
addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttributes, clearAttributes, depth, getAlias, getAttribute, getAttribute, getClassPath, getDeclaringArtifact, getDeclaringEntity, getDeclaringEntityRoot, getDeclaringField, getDeclaringFieldEntityRoot, getDeclaringFieldIndex, getDeclaringFieldPersistentEntityRoot, getDeclaringFieldPersistentEntityTableRoot, getDeclaringOperation, getDeclaringPersistentEntity, getDeclaringPersistentEntityRoot, getDefaultCollectionLabel, getDefaultCollectionShortLabel, getDefaultDescription, getDefaultLabel, getDefaultLocale, getDefaultShortDescription, getDefaultShortLabel, getDefaultSymbol, getDefaultTooltip, getFullName, getLocalizedCollectionLabel, getLocalizedCollectionShortLabel, getLocalizedDescription, getLocalizedLabel, getLocalizedShortDescription, getLocalizedShortLabel, getLocalizedSymbol, getLocalizedTooltip, getName, getPartialName, getPathList, getPathString, getSqlName, hashCodeHexString, isAnnotated, isClassInPath, isDeclared, isExpression, isFinalised, isInherited, isInheritedFromAbstract, isInheritedFromConcrete, isNotDeclared, isNotInherited, isNotInheritedFromAbstract, isNotInheritedFromConcrete, isOperation, put, round, setAlias, setDefaultCollectionLabel, setDefaultCollectionShortLabel, setDefaultDescription, setDefaultLabel, setDefaultShortDescription, setDefaultShortLabel, setDefaultSymbol, setDefaultTooltip, setLocalizedCollectionLabel, setLocalizedCollectionShortLabel, setLocalizedDescription, setLocalizedLabel, setLocalizedShortDescription, setLocalizedShortLabel, setLocalizedSymbol, setLocalizedTooltip, setSqlName, toString, toString, toString, toString
-
-
-
-
Method Detail
-
getSourceEntity
public Entity getSourceEntity()
- Returns:
- the source entity
-
getTargetEntityClass
public Class getTargetEntityClass()
- Returns:
- the target entity class
-
getTargetEntity
public Entity getTargetEntity()
- Returns:
- the target entity
-
getMappedByFieldName
public String getMappedByFieldName()
- Returns:
- the mapped by field name
-
getMappedByField
public Field getMappedByField()
- Returns:
- the mapped by field
-
getMappedByProperty
public Property getMappedByProperty()
- Returns:
- the mapped by property
-
isOneToMany
public boolean isOneToMany()
- Returns:
- true if the entity defines a one-to-many relationship
-
getFetchType
public FetchType getFetchType()
- Returns:
- the fetch type
-
setFetchType
public void setFetchType(FetchType fetchType)
El método setFetchType se utiliza para establecer la estrategia para obtener datos de la base de datos. Con la estrategia EAGER los datos de la colección deben obtenerse simultáneamente con la entidad. Con la estrategia LAZY los datos de la colección pueden obtenerse posteriormente, cuando se accede a ella por primera vez. El valor predeterminado del atributo es EAGER si los elementos de la colección son actualizables; de lo contrario, LAZY.- Parameters:
fetchType- estrategia para obtener datos de la base de datos.
-
getCascadeType
public CascadeType[] getCascadeType()
- Returns:
- the cascade type
-
setCascadeType
public void setCascadeType(CascadeType... cascadeType)
El método setCascadeType se utiliza para establecer el conjunto de operaciones que se propagan a la entidad relacionada. Especifique ALL para propagar todas las operaciones. Incluya PERSIST, MERGE, REMOVE, REFRESH y/o DETACH para propagar la operación persist, merge, remove, refresh y/o detach, respectivamente. El valor predeterminado del atributo es {CascadeType.PERSIST, CascadeType.REFRESH}- Parameters:
cascadeType- conjunto de operaciones que se propagan a la entidad relacionada.
-
getCascadeTypeString
public String getCascadeTypeString()
- Returns:
- the cascade type
-
isCascadeRefresh
public boolean isCascadeRefresh()
- Returns:
- the cascade refresh indicator
-
isCascadePersist
public boolean isCascadePersist()
- Returns:
- the cascade persist indicator
-
isCascadeMerge
public boolean isCascadeMerge()
- Returns:
- the cascade merge indicator
-
isCascadeRemove
public boolean isCascadeRemove()
- Returns:
- the cascade remove indicator
-
isOrphanRemoval
public boolean isOrphanRemoval()
- Returns:
- the orphan removal indicator
-
setOrphanRemoval
public void setOrphanRemoval(boolean remove)
El método setOrphanRemoval se utiliza para establecer si se aplica la operación de eliminación a las entidades que se han eliminado de la relación y si se conecta en cascada la operación de eliminación a esas entidades. El valor predeterminado del atributo es TRUE si los elementos de la colección son actualizables; de lo contrario, FALSE.- Parameters:
remove- true si se aplica la operación de eliminación; de lo contrario, false.
-
isCreateField
public boolean isCreateField()
- Returns:
- the create field indicator
-
setCreateField
public void setCreateField(boolean create)
El método setCreateField se utiliza para establecer si la colección es, o no, requerida por la operación insert de las vistas (páginas) de registro. Este atributo es relevante solo si el valor especificado, o determinado, para el atributo cascade de la colección es ALL o incluye PERSIST. El valor predeterminado del atributo es TRUE si el atributo cascade de la colección incluye PERSIST; en caso contrario es FALSE.- Parameters:
create- true si la colección es requerida por la operación insert de las vistas (páginas) de registro; de lo contrario, false.
-
isUpdateField
public boolean isUpdateField()
- Returns:
- the update field indicator
-
setUpdateField
public void setUpdateField(boolean update)
El método setUpdateField se utiliza para establecer si la colección es, o no, requerida por la operación update de las vistas (páginas) de registro. Este atributo es relevante solo si el valor especificado, o determinado, para el atributo cascade de la colección es ALL o incluye MERGE. El valor predeterminado del atributo es TRUE si el atributo cascade de la colección incluye MERGE; en caso contrario es FALSE.- Parameters:
update- true si la colección es requerida por la operación update de las vistas (páginas) de registro; de lo contrario, false.
-
isDetailField
public boolean isDetailField()
- Returns:
- the detail field indicator
-
setDetailField
public void setDetailField(boolean detail)
El método setDetailField se utiliza para establecer si la colección es, o no, visible en las vistas (páginas) de consulta y registro detallado. Este atributo es relevante solo si el valor especificado, o determinado, para el atributo cascade de la colección es ALL o incluye REFRESH. El valor predeterminado del atributo es TRUE si el atributo cascade de la colección incluye REFRESH; en caso contrario es FALSE.- Parameters:
detail- true si la colección es visible en las vistas (páginas) de consulta y registro detallado; de lo contrario, false.
-
isAuditable
public boolean isAuditable()
- Returns:
- the auditable indicator
-
isNullable
public boolean isNullable()
- Returns:
- the nullable indicator
-
isRenderingFilterReadOnly
public boolean isRenderingFilterReadOnly()
- Returns:
- the rendering filter's read-only indicator
-
getRenderingFilter
public BooleanExpression getRenderingFilter()
- Returns:
- the rendering filter
-
setRenderingFilter
public void setRenderingFilter(BooleanExpression renderingFilter)
El método setRenderingFilter se utiliza para establecer el filtro de presentación de la colección en las vistas (páginas) de consulta y/o registro de la entidad. En las instancias de la entidad que no cumplen con los criterios del filtro, la colección será invisible.- Parameters:
renderingFilter- expresión booleana que se utiliza como filtro para lectura y escritura.
-
setRenderingFilter
public void setRenderingFilter(BooleanExpression renderingFilter, boolean readOnly)
El método setRenderingFilter se utiliza para establecer el filtro de presentación de la colección en las vistas (páginas) de consulta y/o registro de la entidad. En las instancias de la entidad que no cumplen con los criterios del filtro, la colección será invisible.- Parameters:
renderingFilter- expresión booleana que se utiliza como filtroreadOnly- true, si el filtro solo aplica para lectura; false, si también aplica para escritura (al agregar o editar).
-
getPropertyAccess
public PropertyAccess getPropertyAccess()
- Returns:
- the property access
-
setPropertyAccess
public void setPropertyAccess(PropertyAccess access)
El método setPropertyAccess se utiliza para establecer el tipo de control de acceso de la colección. Su valor es uno de los elementos de la enumeración PropertyAccess. Especifique RESTRICTED_WRITING o RESTRICTED_READING para acceso restringido de escritura o lectura, respectivamente. Alternativamente, omita el elemento o especifique UNSPECIFIED para acceso no restringido.- Parameters:
access- tipo de control de acceso de la colección.
-
getDataEntryFormat
public DataEntryFormat getDataEntryFormat()
- Returns:
- the data-entry display format preference
-
setDataEntryFormat
public void setDataEntryFormat(DataEntryFormat format)
El método setDataEntryFormat se utiliza para establecer el orden de búsqueda de la vista (página) para entrada de datos de la colección. Su valor es uno de los elementos de la enumeración DataEntryFormat. Seleccione DETAIL_OR_TABLE o TABLE_OR_DETAIL para buscar primero la vista de formato detallado o tabular, respectivamente. Alternativamente, omita el elemento o seleccione UNSPECIFIED para utilizar el valor predeterminado del atributo. El valor predeterminado del atributo es DETAIL_OR_TABLE.- Parameters:
format- orden de búsqueda de la vista (página) para entrada de datos de la colección.
-
getStep
public Step getStep()
- Returns:
- the step containing this collection
-
getTab
public Tab getTab()
- Returns:
- the tab containing this collection
-
getDisplay
public Display getDisplay()
- Returns:
- the entity collection display
-
getTableDisplay
public Display getTableDisplay()
- Returns:
- the entity collection table display
-
getDetailDisplay
public Display getDetailDisplay()
- Returns:
- the entity collection detail display
-
getExtensionDisplay
public Display getExtensionDisplay(Entity extension)
- Parameters:
extension-- Returns:
- the entity collection display
-
getAggregatesList
public List<EntityCollectionAggregate> getAggregatesList()
- Returns:
- the aggregates list
-
addCount
public EntityCollectionAggregate addCount(int minimum)
-
addCount
public EntityCollectionAggregate addCount(int minimum, int maximum)
-
addCount
public EntityCollectionAggregate addCount(String fieldName, int minimum)
-
addCount
public EntityCollectionAggregate addCount(String fieldName, int minimum, int maximum)
-
addSum
public EntityCollectionAggregate addSum(String fieldName, Number minimum)
-
addSum
public EntityCollectionAggregate addSum(String fieldName, Number minimum, Number maximum)
-
addAverage
public EntityCollectionAggregate addAverage(String fieldName, Number minimum)
-
addAverage
public EntityCollectionAggregate addAverage(String fieldName, Number minimum, Number maximum)
-
addCount
public EntityCollectionAggregate addCount(NumericExpression minimum)
-
addCount
public EntityCollectionAggregate addCount(NumericExpression minimum, NumericExpression maximum)
-
addCount
public EntityCollectionAggregate addCount(String fieldName, NumericExpression minimum)
-
addCount
public EntityCollectionAggregate addCount(String fieldName, NumericExpression minimum, NumericExpression maximum)
-
addSum
public EntityCollectionAggregate addSum(String fieldName, NumericExpression minimum)
-
addSum
public EntityCollectionAggregate addSum(String fieldName, NumericExpression minimum, NumericExpression maximum)
-
addAverage
public EntityCollectionAggregate addAverage(String fieldName, NumericExpression minimum)
-
addAverage
public EntityCollectionAggregate addAverage(String fieldName, NumericExpression minimum, NumericExpression maximum)
-
addCount
public EntityCollectionAggregate addCount(int minimum, NumericExpression maximum)
-
addCount
public EntityCollectionAggregate addCount(NumericExpression minimum, int maximum)
-
addCount
public EntityCollectionAggregate addCount(String fieldName, int minimum, NumericExpression maximum)
-
addCount
public EntityCollectionAggregate addCount(String fieldName, NumericExpression minimum, int maximum)
-
addSum
public EntityCollectionAggregate addSum(String fieldName, Number minimum, NumericExpression maximum)
-
addSum
public EntityCollectionAggregate addSum(String fieldName, NumericExpression minimum, Number maximum)
-
addAverage
public EntityCollectionAggregate addAverage(String fieldName, Number minimum, NumericExpression maximum)
-
addAverage
public EntityCollectionAggregate addAverage(String fieldName, NumericExpression minimum, Number maximum)
-
isEntityCollectionField
public boolean isEntityCollectionField()
- Returns:
- the entity collection field indicator
-
isEntityCollectionWithDisplay
public boolean isEntityCollectionWithDisplay()
- Returns:
- the entity collection with display indicator
-
getValidFieldAnnotations
protected List<Class<? extends Annotation>> getValidFieldAnnotations()
- Overrides:
getValidFieldAnnotationsin classAbstractArtifact
-
finalise
public boolean finalise()
Description copied from interface:Artifactdot the i's and cross the t's- Specified by:
finalisein interfaceArtifact- Overrides:
finalisein classAbstractArtifact- Returns:
- true if this artifact was successfully finalised; otherwise false
-
-