Package adalid.core

Class View

java.lang.Object

adalid.core.AbstractArtifact

adalid.core.View

All Implemented Interfaces:

Wrappable, Artifact

public class View
extends AbstractArtifact

Author:

Jorge Campins

Field Summary

Fields inherited from class adalid.core.AbstractArtifact

_de_, _of_, BR, ENGLISH, HT, PORTUGUESE, SPANISH

Constructor Summary

Constructors

Constructor	Description
View()

Method Summary

Modifier and Type	Method	Description
protected String	fieldsToString(int n, String key, boolean verbose, boolean fields, boolean maps)
boolean	finalise()	dot the i's and cross the t's
PersistentEntity	getEntity()
ViewField	getField(Property column)
ViewField	getLastControlField()
PageFormat	getPageFormat()
Class<? extends PageFormat>	getPageFormatClass()
ViewField	getPenultimateControlField()
String	getSelectStatement(String view, SelectOption option)
List<ViewField>	getViewAggregationFields()
List<ViewField>	getViewControlFields()
List<ViewField>	getViewDetailFields()
List<ViewField>	getViewFields()
List<ViewField>	getViewOrderByFields()
ViewSelect	getViewSelect(String view, SelectOption option)
boolean	isChartable()
boolean	isSelectable()
boolean	isShareable()
boolean	isSummarizable()
protected String	mapsToString(int n, String key, boolean verbose, boolean fields, boolean maps)
ViewField	newControlField(Property column)	El método newControlField se utiliza para agregar propiedades de control a la vista.
ViewField	newControlField(Property column, SortOption sort)	El método newControlField se utiliza para agregar propiedades de control a la vista.
ViewField	newDetailField(Property column)	El método newDetailField se utiliza para agregar propiedades de detalle a la vista.
ViewField	newDetailField(Property column, SortOption sort)	El método newDetailField se utiliza para agregar propiedades de detalle a la vista.
ViewField	newDetailField(Property column, ViewFieldAggregation aggregation)	El método newDetailField se utiliza para agregar propiedades de detalle a la vista.
ViewField	newDetailField(Property column, ViewFieldAggregation aggregation, SortOption sort)	El método newDetailField se utiliza para agregar propiedades de detalle a la vista.
ViewField	newHeadingField(Property column, Property group)	El método newHeadingField se utiliza para agregar propiedades a los encabezados de los grupos de agregación.
void	setPageFormatClass(Class<? extends PageFormat> pageFormatClass)	El método setPageFormatClass establece la clase que define el formato de página de los informes generados para la vista.
void	setShareable(boolean shareable)	El método setShareable se utiliza para especificar si la vista se puede compartir, o no.

Methods inherited from class adalid.core.AbstractArtifact

a, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttributes, annotate, b, b, bigDecimal, bigInteger, checkName, classToString, clearAttributes, coalesce, copyLocalizedStrings, defaultLocale, depth, fa, finish, 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, getValidFieldAnnotations, getValidTypeAnnotations, getValueString, getValueString, getWrapper, h1, h2, h3, h4, h5, h6, hashCodeHexString, i, i, ic, ic, isAnnotated, isClassInPath, isDeclared, isExpression, isFinalised, isFinished, isFontAwesomeClass, isInherited, isInheritedFromAbstract, isInheritedFromConcrete, isLocalizedSymbolDefined, isNotDeclared, isNotInherited, isNotInheritedFromAbstract, isNotInheritedFromConcrete, isOperation, isValidEmbeddedDocument, isValidFieldAnnotation, isValidHelpFileName, isValidHelpFileType, isValidJavaClassName, isValidSnippetFileName, isValidTypeAnnotation, localeReadingKey, localeWritingKey, m, m, put, round, s, s, 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, u, u, ul, verifyExpression, verifyExpression, verifyExpression, verifyExpression, verifyExpression, verifyExpression, verifyNames

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

View

public View()

Method Detail

isShareable

public boolean isShareable()

Returns:

the shareable indicator

setShareable

public void setShareable(boolean shareable)

El método setShareable se utiliza para especificar si la vista se puede compartir, o no. Las vistas compartibles se definen como vistas públicas en la aplicación generada, de modo que todos los usuarios autorizados a hacer consultas sobre la entidad puedan utilizarla. De manera predeterminada, todas las vistas del modelo son compartibles. Este método se puede utilizar para dejar de compartir algunas de ellas.

Parameters:

shareable - true, si la vista se puede compartir; de lo contrario, false.

isSelectable

public boolean isSelectable()

Returns:

the selectable indicator

isSummarizable

public boolean isSummarizable()

Returns:

the summarizable indicator

isChartable

public boolean isChartable()

Returns:

the chartable indicator

getPageFormat

public PageFormat getPageFormat()

Returns:

the page format

getPageFormatClass

public Class<? extends PageFormat> getPageFormatClass()

Returns:

the page format class

setPageFormatClass

public void setPageFormatClass(Class<? extends PageFormat> pageFormatClass)

El método setPageFormatClass establece la clase que define el formato de página de los informes generados para la vista. El formato de página define el tamaño del papel, la orientación (horizontal o vertical) y los márgenes del informe. La clase debe ser una extensión de adalid.core.page.format.AbstractPageFormat, no puede ser una clase abstracta, y su constructor predeterminado (sin argumentos) debe ejecutar el constructor protegido de AbstractPageFormat que da valor a todos los campos requeridos del formato. El valor predeterminado del atributo es adalid.core.page.format.DefaultPageFormat.class. Este es un formato de página personalizado, para papel tamaño EDP americano (Eastern Daily Press), con orientación horizontal. Además de la clase DefaultPageFormat, el paquete adalid.core.page.format también contiene:

• LandscapeA4: papel tamaño A4, orientación horizontal.
• LandscapeB5: papel tamaño B5, orientación horizontal.
• LandscapeLegal: papel tamaño Legal, orientación horizontal.
• LandscapeLetter: papel tamaño Carta, orientación horizontal.
• Ledger: papel tamaño Doble Carta, orientación horizontal.
• PortraitA4: papel tamaño A4, orientación vertical.
• PortraitB5: papel tamaño B5, orientación vertical.
• PortraitLegal: papel tamaño Legal, orientación vertical.
• PortraitLetter: papel tamaño Carta, orientación vertical.
• Tabloid: papel tamaño Doble Carta, orientación vertical.

Parameters:

pageFormatClass - clase que define el formato de página

See Also:

Paper size, Formato de papel

getEntity

public PersistentEntity getEntity()

Returns:

the entity

getLastControlField

public ViewField getLastControlField()

Returns:

the last control field

getPenultimateControlField

public ViewField getPenultimateControlField()

Returns:

the penultimate control field

getViewFields

public List<ViewField> getViewFields()

Returns:

the fields list

getField

public ViewField getField(Property column)

Parameters:

column - the field's column

Returns:

the field

getViewDetailFields

public List<ViewField> getViewDetailFields()

Returns:

the detail fields list

getViewControlFields

public List<ViewField> getViewControlFields()

Returns:

the control fields list

getViewAggregationFields

public List<ViewField> getViewAggregationFields()

Returns:

the aggregation fields list

getViewOrderByFields

public List<ViewField> getViewOrderByFields()

Returns:

the order-by fields list

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

newControlField

public ViewField newControlField(Property column)

El método newControlField se utiliza para agregar propiedades de control a la vista. Las propiedades de control definen los grupos de agregación de la vista. Las vistas pueden o no tener propiedades de control.

Parameters:

column - una de las propiedades de la entidad; el orden de la propiedad en la vista será ascendente.

Returns:

campo de la vista correspondiente a la propiedad agregada.

newControlField

public ViewField newControlField(Property column,
                                 SortOption sort)

El método newControlField se utiliza para agregar propiedades de control a la vista. Las propiedades de control definen los grupos de agregación de la vista. Las vistas pueden o no tener propiedades de control.

Parameters:

column - una de las propiedades de la entidad; el orden será ascendente.

sort - especifica el orden de la propiedad en la vista. Su valor es uno de los elementos de la enumeración SortOption. Seleccione ASC o DESC para establecer el orden como ascendente o descendente, respectivamente.

Returns:

campo de la vista correspondiente a la propiedad agregada.

newHeadingField

public ViewField newHeadingField(Property column,
                                 Property group)

El método newHeadingField se utiliza para agregar propiedades a los encabezados de los grupos de agregación. Inicialmente, los encabezados de los grupos de agregación de los informes generados a partir de la vista tienen una sola propiedad (la propiedad de control que se utilizó para definir el grupo).

Parameters:

column - una de las propiedades de la entidad.

group - propiedad de control que se utilizó para definir el grupo al que se desea agregar la propiedad.

Returns:

campo de la vista correspondiente a la propiedad agregada.

newDetailField

public ViewField newDetailField(Property column)

El método newDetailField se utiliza para agregar propiedades de detalle a la vista. Las vistas pueden o no tener propiedades de detalle.

Parameters:

column - una de las propiedades de la entidad.

Returns:

campo de la vista correspondiente a la propiedad agregada.

newDetailField

public ViewField newDetailField(Property column,
                                ViewFieldAggregation aggregation)

El método newDetailField se utiliza para agregar propiedades de detalle a la vista. Las vistas pueden o no tener propiedades de detalle.

Parameters:

column - una de las propiedades de la entidad.

aggregation - funciones de agregación de la propiedad en la vista.

Returns:

campo de la vista correspondiente a la propiedad agregada.

newDetailField

public ViewField newDetailField(Property column,
                                SortOption sort)

El método newDetailField se utiliza para agregar propiedades de detalle a la vista. Las vistas pueden o no tener propiedades de detalle.

Parameters:

column - una de las propiedades de la entidad.

sort - especifica el orden de la propiedad en la vista. Su valor es uno de los elementos de la enumeración SortOption. Seleccione ASC o

Returns:

campo de la vista correspondiente a la propiedad agregada.

newDetailField

public ViewField newDetailField(Property column,
                                ViewFieldAggregation aggregation,
                                SortOption sort)

El método newDetailField se utiliza para agregar propiedades de detalle a la vista. Las vistas pueden o no tener propiedades de detalle.

Parameters:

column - una de las propiedades de la entidad.

aggregation - funciones de agregación de la propiedad en la vista.

sort - especifica el orden de la propiedad en la vista. Su valor es uno de los elementos de la enumeración SortOption. Seleccione ASC o

Returns:

campo de la vista correspondiente a la propiedad agregada.

getViewSelect

public ViewSelect getViewSelect(String view,
                                SelectOption option)

getSelectStatement

public String getSelectStatement(String view,
                                 SelectOption option)

fieldsToString

protected String fieldsToString(int n,
                                String key,
                                boolean verbose,
                                boolean fields,
                                boolean maps)

Overrides:

fieldsToString in class AbstractArtifact

mapsToString

protected String mapsToString(int n,
                              String key,
                              boolean verbose,
                              boolean fields,
                              boolean maps)

Overrides:

mapsToString in class AbstractArtifact