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

  • Constructor Details

    • EntityCollection

      public EntityCollection()

  • Method Details

    • getSourceEntity

      public Entity getSourceEntity()
      Returns:
      the source entity

    • getTargetEntityClass

      public Class<? extends Entity> 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

    • getQuickAddingFieldName

      public String getQuickAddingFieldName()
      Returns:
      the quick adding field name

    • getQuickAddingField

      public Field getQuickAddingField()
      Returns:
      the quick adding field

    • getQuickAddingProperty

      public Property getQuickAddingProperty()
      Returns:
      the quick adding property

    • getQuickAddingFilter

      public QuickAddingFilter getQuickAddingFilter()
      Returns:
      the quick adding filter

    • 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.

    • isRemoveField

      protected boolean isRemoveField()
      Returns:
      the remove field indicator

    • setRemoveField

      protected void setRemoveField(boolean remove)
      El método setRemoveField se utiliza para establecer si la colección es, o no, requerida por la operación delete 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:
      remove - true si la colección es requerida por la operación delete 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 filtro
      readOnly - true, si el filtro solo aplica para lectura; false, si también aplica para escritura (al agregar o editar).

    • getNullifyingFilter

      public BooleanExpression getNullifyingFilter()
      Returns:
      the nullifying filter

    • setNullifyingFilter

      public void setNullifyingFilter(BooleanExpression nullifyingFilter)
      El método setNullifyingFilter se utiliza para establecer el filtro de anulación de la colección en las vistas (páginas) de registro de la entidad. En las instancias de la entidad que cumplen con los criterios del filtro, la colección será anulada.
      Parameters:
      nullifyingFilter - expresión booleana que se utiliza como filtro.

    • 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.

    • getAfterReadingSnippetFileName

      public String getAfterReadingSnippetFileName()
      Returns:
      the after reading collection snippet file name

    • setAfterReadingSnippetFileName

      protected void setAfterReadingSnippetFileName(String fileName)

    • getAfterWritingSnippetFileName

      public String getAfterWritingSnippetFileName()
      Returns:
      the after writing collection snippet file name

    • setAfterWritingSnippetFileName

      protected void setAfterWritingSnippetFileName(String fileName)

    • getBeforeReadingSnippetFileName

      public String getBeforeReadingSnippetFileName()
      Returns:
      the before reading collection snippet file name

    • setBeforeReadingSnippetFileName

      protected void setBeforeReadingSnippetFileName(String fileName)

    • getBeforeWritingSnippetFileName

      public String getBeforeWritingSnippetFileName()
      Returns:
      the before writing collection snippet file name

    • setBeforeWritingSnippetFileName

      protected void setBeforeWritingSnippetFileName(String fileName)

    • getReadingViewRowActionSnippetFileName

      public String getReadingViewRowActionSnippetFileName()
      Returns:
      the reading table view collection row action snippet file name

    • setReadingViewRowActionSnippetFileName

      protected void setReadingViewRowActionSnippetFileName(String fileName)

    • getReadingViewRowStatusSnippetFileName

      public String getReadingViewRowStatusSnippetFileName()
      Returns:
      the reading table view collection row status snippet file name

    • setReadingViewRowStatusSnippetFileName

      protected void setReadingViewRowStatusSnippetFileName(String fileName)

    • getReadingViewRowNumberSnippetFileName

      public String getReadingViewRowNumberSnippetFileName()
      Returns:
      the reading table view collection row number snippet file name

    • setReadingViewRowNumberSnippetFileName

      protected void setReadingViewRowNumberSnippetFileName(String fileName)

    • getWritingViewRowActionSnippetFileName

      public String getWritingViewRowActionSnippetFileName()
      Returns:
      the writing table view collection row action snippet file name

    • setWritingViewRowActionSnippetFileName

      protected void setWritingViewRowActionSnippetFileName(String fileName)

    • getWritingViewRowStatusSnippetFileName

      public String getWritingViewRowStatusSnippetFileName()
      Returns:
      the writing table view collection row status snippet file name

    • setWritingViewRowStatusSnippetFileName

      protected void setWritingViewRowStatusSnippetFileName(String fileName)

    • getWritingViewRowNumberSnippetFileName

      public String getWritingViewRowNumberSnippetFileName()
      Returns:
      the writing table view collection row number snippet file name

    • setWritingViewRowNumberSnippetFileName

      protected void setWritingViewRowNumberSnippetFileName(String fileName)

    • getStep

      public Step getStep()
      Returns:
      the step containing this collection

    • getTab

      public Tab getTab()
      Returns:
      the tab containing this collection

    • getDisplay

      public Display getDisplay(String pageDisplayMode)
      Parameters:
      pageDisplayMode - page display mode (READING or WRITING)
      Returns:
      the entity collection display

    • getTableDisplay

      public Display getTableDisplay(String pageDisplayMode)
      Parameters:
      pageDisplayMode - page display mode (READING or WRITING)
      Returns:
      the entity collection table display

    • getDetailDisplay

      public Display getDetailDisplay(String pageDisplayMode)
      Parameters:
      pageDisplayMode - page display mode (READING or WRITING)
      Returns:
      the entity collection detail display

    • getInsertDisplay

      public Display getInsertDisplay()
      Returns:
      the entity collection insert display

    • getUpdateDisplay

      public Display getUpdateDisplay()
      Returns:
      the entity collection update display

    • getDeleteDisplay

      public Display getDeleteDisplay()
      Returns:
      the entity collection delete display

    • getExtensionDisplay

      public Display getExtensionDisplay(Entity extension, String pageDisplayMode)
      Retorna el objeto Display de la extensión de la entidad que corresponde a la página que se debe abrir en un diálogo. Se usa en la macro inicializarCollectionDataTableControllers de jee2/web/java/pages/blocks/archetype/pagina-consulta-con-coleccion.vm
      Parameters:
      extension - extension
      pageDisplayMode - page display mode (READING or WRITING)
      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)

    • getRenderingFilterTag

      public String getRenderingFilterTag()
      Returns:
      the rendering filter tag

    • setRenderingFilterTag

      public void setRenderingFilterTag(String tag)
      El método setRenderingFilterTag se utiliza para establecer la descripción del filtro de presentación de la colección que se almacena en el archivo de recursos por defecto. En caso de que el archivo de recursos para el idioma seleccionado por el usuario no esté disponible, la interfaz de la aplicación utiliza el archivo de recursos por defecto para obtener el valor de la descripción.
      Parameters:
      tag - una o más oraciones que describen muy brevemente el filtro de presentación de la colección

    • getNullifyingFilterTag

      public String getNullifyingFilterTag()
      Returns:
      the nullifying filter tag

    • setNullifyingFilterTag

      public void setNullifyingFilterTag(String tag)
      El método setNullifyingFilterTag se utiliza para establecer la descripción del filtro de anulación de la colección que se almacena en el archivo de recursos por defecto. En caso de que el archivo de recursos para el idioma seleccionado por el usuario no esté disponible, la interfaz de la aplicación utiliza el archivo de recursos por defecto para obtener el valor de la descripción.
      Parameters:
      tag - una o más oraciones que describen muy brevemente el filtro de anulación de la colección

    • getLocalizedRenderingFilterTag

      public String getLocalizedRenderingFilterTag(Locale locale)
      Parameters:
      locale - the locale for the tag
      Returns:
      the rendering filter tag

    • setLocalizedRenderingFilterTag

      public void setLocalizedRenderingFilterTag(Locale locale, String tag)
      El método setLocalizedRenderingFilterTag se utiliza para establecer la descripción del filtro de presentación de la colección que se almacena en el archivo de recursos de configuración regional. En caso de que el archivo de recursos para el idioma seleccionado por el usuario no esté disponible, la interfaz de la aplicación utiliza el archivo de recursos por defecto para obtener el valor de la descripción.
      Parameters:
      locale - configuración regional
      tag - una o más oraciones que describen muy brevemente el filtro de presentación de la colección

    • getLocalizedNullifyingFilterTag

      public String getLocalizedNullifyingFilterTag(Locale locale)
      Parameters:
      locale - the locale for the tag
      Returns:
      the nullifying filter tag

    • setLocalizedNullifyingFilterTag

      public void setLocalizedNullifyingFilterTag(Locale locale, String tag)
      El método setLocalizedNullifyingFilterTag se utiliza para establecer la descripción del filtro de anulación de la colección que se almacena en el archivo de recursos de configuración regional. En caso de que el archivo de recursos para el idioma seleccionado por el usuario no esté disponible, la interfaz de la aplicación utiliza el archivo de recursos por defecto para obtener el valor de la descripción.
      Parameters:
      locale - configuración regional
      tag - una o más oraciones que describen muy brevemente el filtro de anulación de la colección

    • isEntityCollectionField

      public boolean isEntityCollectionField()
      Returns:
      the entity collection field indicator

    • isEntityCollectionField

      public boolean isEntityCollectionField(String pageDisplayMode)
      Parameters:
      pageDisplayMode - page display mode (READING or WRITING)
      Returns:
      the entity collection field indicator

    • isEntityCollectionWithDisplay

      public boolean isEntityCollectionWithDisplay()
      Returns:
      the entity collection with display indicator

    • isEntityCollectionWithDisplay

      public boolean isEntityCollectionWithDisplay(String pageDisplayMode)
      Parameters:
      pageDisplayMode - page display mode (READING or WRITING)
      Returns:
      the entity collection with writing display indicator

    • isEntityCollectionWithReadingDisplay

      public boolean isEntityCollectionWithReadingDisplay()
      Returns:
      the entity collection with reading display indicator

    • isEntityCollectionWithWritingDisplay

      public boolean isEntityCollectionWithWritingDisplay()
      Returns:
      the entity collection with writing display indicator

    • getValidFieldAnnotations

      protected List<Class<? extends Annotation>> getValidFieldAnnotations()
      Overrides:
      getValidFieldAnnotations in class AbstractArtifact

    • finalise

      public boolean finalise()
      Description copied from interface: Artifact
      dot the i's and cross the t's
      Specified by:
      finalise in interface Artifact
      Overrides:
      finalise in class AbstractArtifact
      Returns:
      true if this artifact was successfully finalised; otherwise false