Package adalid.core

Class Project

    • Field Detail

      • STRING_FIELD_MAX_LENGTH

        public static final int STRING_FIELD_MAX_LENGTH
        See Also:
        Constant Field Values
      • STRING_INDEX_MAX_LENGTH

        public static final int STRING_INDEX_MAX_LENGTH
        See Also:
        Constant Field Values
      • CHARACTER_KEY_MAX_LENGTH

        public static final int CHARACTER_KEY_MAX_LENGTH
        See Also:
        Constant Field Values
      • NAME_PROPERTY_MAX_LENGTH

        public static final int NAME_PROPERTY_MAX_LENGTH
        See Also:
        Constant Field Values
      • DESCRIPTION_PROPERTY_MAX_LENGTH

        public static final int DESCRIPTION_PROPERTY_MAX_LENGTH
        See Also:
        Constant Field Values
      • FILE_REFERENCE_MAX_LENGTH

        public static final int FILE_REFERENCE_MAX_LENGTH
        See Also:
        Constant Field Values
      • URL_PROPERTY_MAX_LENGTH

        public static final int URL_PROPERTY_MAX_LENGTH
        See Also:
        Constant Field Values
      • EMBEDDED_DOCUMENT_MAX_LENGTH

        public static final int EMBEDDED_DOCUMENT_MAX_LENGTH
        See Also:
        Constant Field Values
    • Constructor Detail

      • Project

        public Project()
    • Method Detail

      • setBootstrappingFileName

        public static void setBootstrappingFileName​(java.lang.String name)
        El método setBootstrappingFileName se utiliza para establecer el nombre del archivo de configuración inicial del proyecto, en caso de que se deba utilizar un archivo diferente al predeterminado (bootstrapping.properties).
        Parameters:
        name - nombre del archivo, sin la ruta; el archivo debe estar almacenado en el subdirectorio src/main/resources, donde mismo se encuentra el archivo de configuración inicial predeterminado (bootstrapping.properties).
      • getLocale

        public static java.util.Locale getLocale()
        Returns:
        the locale
      • setLocale

        public static void setLocale​(java.util.Locale locale)
        El método setLocale se utiliza para establecer el objeto Locale predeterminado del proyecto (un objeto Locale representa una o región geográfica, política, cultural, etc.). El objeto Locale determina, entre otras cosas, el idioma del archivo de recursos por defecto y el formato predeterminado de fecha y hora. El valor predeterminado de esta propiedad es el Locale predeterminado de la JVM.
        Parameters:
        locale - objeto Locale
      • setCSVSeparator

        public static void setCSVSeparator​(java.util.Locale locale,
                                           char separator)
        El método setCSVSeparator se utiliza para establecer el carácter para separar los campos en archivos CSV para un Locale específico.
        Parameters:
        locale - objeto Locale que representa una o región geográfica, política, cultural, etc.
        separator - separador de campos
      • setCSVQuote

        public static void setCSVQuote​(java.util.Locale locale,
                                       char quote)
        El método setCSVQuote se utiliza para establecer el carácter para delimitar los campos en archivos CSV para un Locale específico.
        Parameters:
        locale - objeto Locale que representa una o región geográfica, política, cultural, etc.
        quote - delimitador de campos
      • setCSVEscape

        public static void setCSVEscape​(java.util.Locale locale,
                                        char escape)
        El método setCSVEscape se utiliza para establecer el carácter para incluir el delimitador en el valor de los campos en archivos CSV para un Locale específico.
        Parameters:
        locale - objeto Locale que representa una o región geográfica, política, cultural, etc.
        escape - escape del delimitador de campos
      • setCSVLineEnd

        public static void setCSVLineEnd​(java.util.Locale locale,
                                         java.lang.String lineEnd)
        El método setCSVLineEnd se utiliza para establecer el fin de línea en archivos CSV para un Locale específico.
        Parameters:
        locale - objeto Locale que representa una o región geográfica, política, cultural, etc.
        lineEnd - fin de línea
      • setCSVNullValue

        public static void setCSVNullValue​(java.util.Locale locale,
                                           java.lang.String nullValue)
        El método setCSVNullValue se utiliza para establecer el equivalente a valores nulos en archivos CSV para un Locale específico.
        Parameters:
        locale - objeto Locale que representa una o región geográfica, política, cultural, etc.
        nullValue - equivalente a valores nulos
      • setDecimalSeparator

        public static void setDecimalSeparator​(java.util.Locale locale,
                                               char separator)
        El método setDecimalSeparator se utiliza para establecer el separador decimal para un Locale específico. El separador decimal es un carácter usado para indicar la separación entre la parte entera y la parte fraccional de un número decimal.
        Parameters:
        locale - objeto Locale que representa una o región geográfica, política, cultural, etc.
        separator - separador decimal
      • setThousandSeparator

        public static void setThousandSeparator​(java.util.Locale locale,
                                                char separator)
        El método setThousandSeparator se utiliza para establecer el separador de millares para un Locale específico. El separador de millares es un carácter situado entre los dígitos de la parte entera de un número para facilitar su lectura, agrupando las cifras de tres en tres.
        Parameters:
        locale - objeto Locale que representa una o región geográfica, política, cultural, etc.
        separator - separador decimal
      • setDateFormat

        public static void setDateFormat​(java.util.Locale locale,
                                         java.lang.String format)
        El método setDateFormat se utiliza para establecer el formato de fecha para un Locale específico. El formato se especifica mediante un patrón de fecha y hora. Para obtener información sobre patrones de fecha y hora consulte la documentación de SimpleDateFormat.
        Parameters:
        locale - objeto Locale que representa una o región geográfica, política, cultural, etc.
        format - patrón de fecha y hora
        See Also:
        SimpleDateFormat
      • setTimeFormat

        public static void setTimeFormat​(java.util.Locale locale,
                                         java.lang.String format)
        El método setTimeFormat se utiliza para establecer el formato de hora para un Locale específico. El formato se especifica mediante un patrón de fecha y hora. Para obtener información sobre patrones de fecha y hora consulte la documentación de SimpleDateFormat.
        Parameters:
        locale - objeto Locale que representa una o región geográfica, política, cultural, etc.
        format - patrón de fecha y hora
        See Also:
        SimpleDateFormat
      • setTimestampFormat

        public static void setTimestampFormat​(java.util.Locale locale,
                                              java.lang.String format)
        El método setTimestampFormat se utiliza para establecer el formato de fecha y hora para un Locale específico. El formato se especifica mediante un patrón de fecha y hora. Para obtener información sobre patrones de fecha y hora consulte la documentación de SimpleDateFormat.
        Parameters:
        locale - objeto Locale que representa una o región geográfica, política, cultural, etc.
        format - patrón de fecha y hora
        See Also:
        SimpleDateFormat
      • getMaximumStringFieldMaxLength

        public static int getMaximumStringFieldMaxLength()
        Returns:
        the maximum string field max length in characters
      • setMaximumStringFieldMaxLength

        public static void setMaximumStringFieldMaxLength​(int maxLength)
        El método setMaximumStringFieldMaxLength se utiliza para establecer la cantidad máxima de caracteres de propiedades StringProperty y parámetros StringParameter con longitud limitada.
        Parameters:
        maxLength - cantidad de caracteres. Su valor debe ser un número entero entre 2.000 y 32.767. El valor predeterminado es 32.767.
      • getMaximumStringIndexMaxLength

        public static int getMaximumStringIndexMaxLength()
        Returns:
        the maximum string index max length in characters
      • setMaximumStringIndexMaxLength

        public static void setMaximumStringIndexMaxLength​(int maxLength)
        El método setMaximumStringIndexMaxLength se utiliza para establecer la cantidad máxima de caracteres de propiedades StringProperty que son indexadas y, por lo tanto, con longitud limitada.
        Parameters:
        maxLength - cantidad de caracteres. Su valor debe ser un número entero entre 1 y el menor entre 6.384 y la cantidad máxima de caracteres de propiedades StringProperty con longitud limitada, que por omisión es 32.767 y puede ser establecida mediante el método setMaximumStringFieldMaxLength. El valor predeterminado es 1.596 (menos de 6398 bytes utilizando el conjunto de caracteres AL32UTF8). El máximo valor que se podría especificar dependerá de la configuración de la base de datos de la aplicación. Tanto en Oracle como en PostgreSQL, dependerá del conjunto de caracteres que utiliza la base de datos. En Oracle, también dependerá del tamaño del bloque del tablespace donde se crea el índice de la propiedad.
        See Also:
        How to Fix ORA-01450: Maximum Key Length (6398) Exceeded Errors
      • getDefaultStringFieldMaxLength

        public static int getDefaultStringFieldMaxLength()
        Returns:
        the default string field max length in characters
      • setDefaultStringFieldMaxLength

        public static void setDefaultStringFieldMaxLength​(int maxLength)
        El método setDefaultStringFieldMaxLength se utiliza para establecer la cantidad predeterminada de caracteres de propiedades StringProperty y de parámetros StringParameter con longitud limitada.
        Parameters:
        maxLength - cantidad de caracteres. Su valor debe ser un número entero entre 0 y la cantidad máxima de caracteres de propiedades StringProperty y de parámetros StringParameter con longitud limitada, que por omisión es 32.767 y puede ser establecida mediante el método setMaximumStringFieldMaxLength. El valor predeterminado es 2.000. Especifique 0 para utilizar el máximo permitido por la plataforma, el cual dependerá del conjunto de caracteres que utiliza la base de datos de la aplicación.
      • getDefaultStringIndexMaxLength

        public static int getDefaultStringIndexMaxLength()
        Returns:
        the default string index max length in characters
      • setDefaultStringIndexMaxLength

        public static void setDefaultStringIndexMaxLength​(int maxLength)
        El método setDefaultStringIndexMaxLength se utiliza para establecer la cantidad predeterminada de caracteres de propiedades StringProperty que son indexadas y, por lo tanto, con longitud limitada.
        Parameters:
        maxLength - cantidad de caracteres. Su valor debe ser un número entero entre 1 y la cantidad máxima de caracteres de propiedades StringProperty que son indexadas, que por omisión es 6.384 y puede ser establecida mediante el método setMaximumStringIndexMaxLength. El valor predeterminado es 1.596 (menos de 6398 bytes utilizando el conjunto de caracteres AL32UTF8).
      • getDefaultCharacterKeyMaxLength

        public static int getDefaultCharacterKeyMaxLength()
        Returns:
        the default character key max length in characters
      • setDefaultCharacterKeyMaxLength

        public static void setDefaultCharacterKeyMaxLength​(int maxLength)
        El método setDefaultCharacterKeyMaxLength se utiliza para establecer la cantidad predeterminada de caracteres de propiedades StringProperty que son la clave de negocio de la entidad y, por lo tanto, indexadas y con longitud limitada.
        Parameters:
        maxLength - cantidad de caracteres. Su valor debe ser un número entero entre 30 y la cantidad máxima de caracteres de propiedades StringProperty que son indexadas, que por omisión es 1.596 y puede ser establecida mediante el método setMaximumStringIndexMaxLength. El valor predeterminado es 30.
      • getDefaultNamePropertyMaxLength

        public static int getDefaultNamePropertyMaxLength()
        Returns:
        the default name property max length in characters
      • setDefaultNamePropertyMaxLength

        public static void setDefaultNamePropertyMaxLength​(int maxLength)
        El método setDefaultNamePropertyMaxLength se utiliza para establecer la cantidad predeterminada de caracteres de propiedades StringProperty que son la propiedad nombre de la entidad y, por lo tanto, indexadas y con longitud limitada.
        Parameters:
        maxLength - cantidad de caracteres. Su valor debe ser un número entero entre 100 y la cantidad máxima de caracteres de propiedades StringProperty que son indexadas, que por omisión es 1.596 y puede ser establecida mediante el método setMaximumStringIndexMaxLength. El valor predeterminado es 100.
      • getDefaultDescriptionPropertyMaxLength

        public static int getDefaultDescriptionPropertyMaxLength()
        Returns:
        the default description property max length in characters
      • setDefaultDescriptionPropertyMaxLength

        public static void setDefaultDescriptionPropertyMaxLength​(int maxLength)
        El método setDefaultDescriptionPropertyMaxLength se utiliza para establecer la cantidad predeterminada de caracteres de propiedades StringProperty que son la propiedad descripción de la entidad.
        Parameters:
        maxLength - cantidad de caracteres. Su valor debe ser un número entero entre 0 y la cantidad máxima de caracteres de propiedades StringProperty con longitud limitada, que por omisión es 32.767 y puede ser establecida mediante el método setMaximumStringFieldMaxLength. El valor predeterminado es 2.000. Especifique 0 para utilizar el máximo permitido por la plataforma, el cual dependerá del conjunto de caracteres que utiliza la base de datos de la aplicación.
      • getDefaultFileReferenceMaxLength

        public static int getDefaultFileReferenceMaxLength()
        Returns:
        the default file reference max length in characters
      • setDefaultFileReferenceMaxLength

        public static void setDefaultFileReferenceMaxLength​(int maxLength)
        El método setDefaultFileReferenceMaxLength se utiliza para establecer la cantidad predeterminada de caracteres de propiedades StringProperty y de parámetros StringParameter que hacen referencia a un archivo.
        Parameters:
        maxLength - cantidad de caracteres. Su valor debe ser un número entero entre 1 y la cantidad máxima de caracteres de propiedades StringProperty con longitud limitada, que por omisión es 32.767 y puede ser establecida mediante el método setMaximumStringFieldMaxLength. El valor predeterminado es 2.000.
      • getDefaultUrlPropertyMaxLength

        public static int getDefaultUrlPropertyMaxLength()
        Returns:
        the default url property max length in characters
      • setDefaultUrlPropertyMaxLength

        public static void setDefaultUrlPropertyMaxLength​(int maxLength)
        El método setDefaultUrlPropertyMaxLength se utiliza para establecer la cantidad predeterminada de caracteres de propiedades StringProperty que que contienen una URL.
        Parameters:
        maxLength - cantidad de caracteres. Su valor debe ser un número entero entre 1 y la cantidad máxima de caracteres de propiedades StringProperty con longitud limitada, que por omisión es 32.767 y puede ser establecida mediante el método setMaximumStringFieldMaxLength. El valor predeterminado es 2.000.
      • getDefaultEmbeddedDocumentMaxLength

        public static int getDefaultEmbeddedDocumentMaxLength()
        Returns:
        the default embedded document max length in characters
      • setDefaultEmbeddedDocumentMaxLength

        public static void setDefaultEmbeddedDocumentMaxLength​(int maxLength)
        El método setDefaultEmbeddedDocumentMaxLength se utiliza para establecer la cantidad predeterminada de caracteres de propiedades StringProperty que contienen la definición de un documento incrustado.
        Parameters:
        maxLength - cantidad de caracteres. Su valor debe ser un número entero entre 1 y la cantidad máxima de caracteres de propiedades StringProperty con longitud limitada, que por omisión es 32.767 y puede ser establecida mediante el método setMaximumStringFieldMaxLength. El valor predeterminado es 2.000.
      • getDefaultMaxDepth

        public static int getDefaultMaxDepth()
        Returns:
        the default max depth
      • setDefaultMaxDepth

        public static void setDefaultMaxDepth​(int depth)
        Parameters:
        depth - the default max depth to set
      • getDefaultMaxRound

        public static int getDefaultMaxRound()
        Returns:
        the default max round
      • setDefaultMaxRound

        public static void setDefaultMaxRound​(int round)
        Parameters:
        round - the default max round to set
      • getDefaultEntityCodeGenBPL

        public static boolean getDefaultEntityCodeGenBPL()
        Returns:
        the default @EntityCodeGen BPL (Business Process Logic) value
      • setDefaultEntityCodeGenBPL

        public static void setDefaultEntityCodeGenBPL​(boolean b)
        El método setDefaultEntityCodeGenBPL se utiliza para establecer el valor predeterminado del atributo bpl de las meta-entidades. El atributo indica si se debe, o no, generar código BPL (Business Process Logic) para la entidad. El método setDefaultEntityCodeGenBPL es un método estático que debe ejecutarse en el método setStaticAttributes del proyecto maestro.
        Parameters:
        b - valor predeterminado del atributo bpl
      • getDefaultEntityCodeGenBWS

        public static boolean getDefaultEntityCodeGenBWS()
        Returns:
        the default @EntityCodeGen BWS (Business Web Service) value
      • setDefaultEntityCodeGenBWS

        public static void setDefaultEntityCodeGenBWS​(boolean b)
        El método setDefaultEntityCodeGenBWS se utiliza para establecer el valor predeterminado del atributo bws de las meta-entidades. El atributo indica si se debe, o no, generar código BWS (Business Web Service) para la entidad. El método setDefaultEntityCodeGenBWS es un método estático que debe ejecutarse en el método setStaticAttributes del proyecto maestro.
        Parameters:
        b - valor predeterminado del atributo bws
      • getDefaultEntityCodeGenDAF

        public static boolean getDefaultEntityCodeGenDAF()
        Returns:
        the default @EntityCodeGen DAF (Data Access Facade) value
      • setDefaultEntityCodeGenDAF

        public static void setDefaultEntityCodeGenDAF​(boolean b)
        El método setDefaultEntityCodeGenDAF se utiliza para establecer el valor predeterminado del atributo daf de las meta-entidades. El atributo indica si se debe, o no, generar una fachada de acceso a datos (DAF, por las siglas en inglés de Data Access Facade) para la entidad. El método setDefaultEntityCodeGenDAF es un método estático que debe ejecutarse en el método setStaticAttributes del proyecto maestro.
        Parameters:
        b - valor predeterminado del atributo daf
      • getDefaultEntityCodeGenFWS

        public static boolean getDefaultEntityCodeGenFWS()
        Returns:
        the default @EntityCodeGen FWS (Facade Web Service) value
      • setDefaultEntityCodeGenFWS

        public static void setDefaultEntityCodeGenFWS​(boolean b)
        El método setDefaultEntityCodeGenFWS se utiliza para establecer el valor predeterminado del atributo fws de las meta-entidades. El atributo indica si se debe, o no, generar código FWS (Facade Web Service) para la entidad. El método setDefaultEntityCodeGenFWS es un método estático que debe ejecutarse en el método setStaticAttributes del proyecto maestro.
        Parameters:
        b - valor predeterminado del atributo fws
      • getDefaultEntityCodeGenGUI

        public static boolean getDefaultEntityCodeGenGUI()
        Returns:
        the default @EntityCodeGen GUI (Graphical User Interface) value
      • setDefaultEntityCodeGenGUI

        public static void setDefaultEntityCodeGenGUI​(boolean b)
        El método setDefaultEntityCodeGenGUI se utiliza para establecer el valor predeterminado del atributo gui de las meta-entidades. El atributo indica si se debe, o no, generar código GUI (Graphical User Interface) para la entidad. El método setDefaultEntityCodeGenGUI es un método estático que debe ejecutarse en el método setStaticAttributes del proyecto maestro.
        Parameters:
        b - valor predeterminado del atributo gui
      • getDefaultEntityCodeGenSQL

        public static boolean getDefaultEntityCodeGenSQL()
        Returns:
        the default @EntityCodeGen SQL value
      • setDefaultEntityCodeGenSQL

        public static void setDefaultEntityCodeGenSQL​(boolean b)
        El método setDefaultEntityCodeGenSQL se utiliza para establecer el valor predeterminado del atributo sql de las meta-entidades. El atributo indica si se debe, o no, generar código SQL (Structured Query Language) para la entidad. El método setDefaultEntityCodeGenSQL es un método estático que debe ejecutarse en el método setStaticAttributes del proyecto maestro.
        Parameters:
        b - valor predeterminado del atributo sql
      • getDefaultEntityCodeGenSMC

        public static boolean getDefaultEntityCodeGenSMC()
        Returns:
        the default @EntityCodeGen SMC (State Machine Code) value
      • setDefaultEntityCodeGenSMC

        public static void setDefaultEntityCodeGenSMC​(boolean b)
        El método setDefaultEntityCodeGenSMC se utiliza para establecer el valor predeterminado del atributo state de las meta-entidades. El atributo indica si se debe, o no, generar código SMC (State Machine Code) para la entidad. El método setDefaultEntityCodeGenSMC es un método estático que debe ejecutarse en el método setStaticAttributes del proyecto maestro.
        Parameters:
        b - valor predeterminado del atributo state
      • getDefaultPropertyFieldSerializable

        public static java.lang.Boolean getDefaultPropertyFieldSerializable()
        Returns:
        the default @PropertyField.serializable value
      • setDefaultPropertyFieldSerializable

        public static void setDefaultPropertyFieldSerializable​(boolean b)
        El método setDefaultPropertyFieldSerializable se utiliza para establecer el valor predeterminado del elemento serializable de la anotación PropertyField de las meta-propiedades. El atributo indica si la propiedad se debe serializar, o no. El método setDefaultPropertyFieldSerializable es un método estático que debe ejecutarse en el método setStaticAttributes del proyecto maestro.
        Parameters:
        b - valor predeterminado del atributo serializable
      • getDefaultPropertyFieldSerializableIUID

        public static java.lang.Boolean getDefaultPropertyFieldSerializableIUID()
        Returns:
        the default @PropertyField.serializableIUID value
      • setDefaultPropertyFieldSerializableIUID

        public static void setDefaultPropertyFieldSerializableIUID​(boolean b)
        El método setDefaultPropertyFieldSerializableIUID se utiliza para establecer el valor predeterminado del elemento serializableIUID de la anotación PropertyField de las meta-propiedades. El atributo indica si la propiedad se debe serializar, o no, como un IUID (Item Unique Identification). El método setDefaultPropertyFieldSerializableIUID es un método estático que debe ejecutarse en el método setStaticAttributes del proyecto maestro.
        Parameters:
        b - valor predeterminado del atributo serializableIUID
      • isAcerose

        public static boolean isAcerose()
        Returns:
        the acerose
      • setAcerose

        public static void setAcerose​(boolean acerose)
        Parameters:
        acerose - the acerose indicator to set
      • isFoliose

        public static boolean isFoliose()
        Returns:
        the foliose
      • setFoliose

        public static void setFoliose​(boolean foliose)
        Parameters:
        foliose - the foliose indicator to set
      • isSpinose

        public static boolean isSpinose()
        Returns:
        the spinose
      • setSpinose

        public static void setSpinose​(boolean spinose)
        Parameters:
        spinose - the spinose indicator to set
      • isVerbose

        public static boolean isVerbose()
        Returns:
        the verbose
      • setVerbose

        public static void setVerbose​(boolean verbose)
        Parameters:
        verbose - the verbose indicator to set
      • isWarnose

        public static boolean isWarnose()
        Returns:
        the warnose
      • setWarnose

        public static void setWarnose​(boolean warnose)
        El método setWarnose se utiliza para habilitar o inhabilitar las anotaciones EntityWarnings, de manera que al generar la aplicación se muestren, o no, todas las advertencias de todas las entidades. El método setWarnose es un método estático que debe ejecutarse en el método main del proyecto maestro, antes de ejecutar el método build.
        Parameters:
        warnose - true para inhabilitar las anotaciones y, en consecuencia, emitir todos los mensajes; y false para habilitar las anotaciones y, en consecuencia, emitir los mensajes según los elementos de cada anotación.
      • getAlertLevel

        public static org.apache.log4j.Level getAlertLevel()
        Returns:
        the alert messages logging level
      • setAlertLevel

        public static void setAlertLevel​(org.apache.log4j.Level level)
        Parameters:
        level - the alert messages logging level to set; WARN will be used if level is null; ERROR and FATAL are downgraded to WARN; OFF disables alert messages logging
      • getDetailLevel

        public static org.apache.log4j.Level getDetailLevel()
        Returns:
        the detail messages logging level
      • setDetailLevel

        public static void setDetailLevel​(org.apache.log4j.Level level)
        Parameters:
        level - the detail messages logging level to set; INFO will be used if level is null; WARN, ERROR and FATAL are downgraded to INFO; OFF disables detail messages logging
      • getTrackingLevel

        public static org.apache.log4j.Level getTrackingLevel()
        Returns:
        the tracking messages logging level
      • setTrackingLevel

        public static void setTrackingLevel​(org.apache.log4j.Level level)
        Parameters:
        level - the tracking messages logging level to set; TRACE will be used if level is null; WARN, ERROR and FATAL are downgraded to INFO; OFF disables tracking messages logging
      • getTransitionLevel

        public static org.apache.log4j.Level getTransitionLevel()
        Returns:
        the transition messages logging level
      • setTransitionLevel

        public static void setTransitionLevel​(org.apache.log4j.Level level)
        Parameters:
        level - the transition messages logging level to set; ERROR will be used if level is null; OFF disables transition messages logging
      • getSpecialExpressionLevel

        public static org.apache.log4j.Level getSpecialExpressionLevel()
        Returns:
        the special expression messages logging level
      • setSpecialExpressionLevel

        public static void setSpecialExpressionLevel​(org.apache.log4j.Level level)
        Parameters:
        level - the special expression messages logging level to set; ERROR will be used if level is null; OFF disables special expression messages logging
      • getUnusualExpressionLevel

        public static org.apache.log4j.Level getUnusualExpressionLevel()
        Returns:
        the unusual expression messages logging level
      • setUnusualExpressionLevel

        public static void setUnusualExpressionLevel​(org.apache.log4j.Level level)
        Parameters:
        level - the unusual expression messages logging level to set; ERROR will be used if level is null; OFF disables unusual expression messages logging
      • getAlertLoggingLevel

        public static LoggingLevel getAlertLoggingLevel()
        Returns:
        the alert messages logging level
      • setAlertLoggingLevel

        public static void setAlertLoggingLevel​(LoggingLevel level)
        El método setAlertLoggingLevel se utiliza para establecer el nivel de severidad de los mensajes de alerta que se emiten al generar la aplicación. El valor predeterminado de esta propiedad es OFF (no emitir mensajes de alerta). El método setAlertLoggingLevel es un método estático que debe ejecutarse en el método main del proyecto maestro, antes de ejecutar el método build.
        Parameters:
        level - elemento de la enumeración LoggingLevel que determina el nivel de severidad de los mensajes de alerta que se emiten al generar la aplicación. Especifique TRACE, DEBUG, INFO o WARN para emitir los mensajes con uno de esos niveles.
      • getDetailLoggingLevel

        public static LoggingLevel getDetailLoggingLevel()
        Returns:
        the detail messages logging level
      • setDetailLoggingLevel

        public static void setDetailLoggingLevel​(LoggingLevel level)
        El método setDetailLoggingLevel se utiliza para establecer el nivel de severidad de los mensajes de detalle que se emiten al generar la aplicación. El valor predeterminado de esta propiedad es OFF (no emitir mensajes de detalle). El método setDetailLoggingLevel es un método estático que debe ejecutarse en el método main del proyecto maestro, antes de ejecutar el método build.
        Parameters:
        level - elemento de la enumeración LoggingLevel que determina el nivel de severidad de los mensajes de detalle que se emiten al generar la aplicación. Especifique TRACE, DEBUG o INFO para emitir los mensajes con uno de esos niveles.
      • getTrackingLoggingLevel

        public static LoggingLevel getTrackingLoggingLevel()
        Returns:
        the tracking messages logging level
      • setTrackingLoggingLevel

        public static void setTrackingLoggingLevel​(LoggingLevel level)
        El método setTrackingLoggingLevel se utiliza para establecer el nivel de severidad de los mensajes de seguimiento que se emiten al generar la aplicación. El valor predeterminado de esta propiedad es OFF (no emitir mensajes de seguimiento). El método setTrackingLoggingLevel es un método estático que debe ejecutarse en el método main del proyecto maestro, antes de ejecutar el método build.
        Parameters:
        level - elemento de la enumeración LoggingLevel que determina el nivel de severidad de los mensajes de seguimiento que se emiten al generar la aplicación. Especifique TRACE, DEBUG o INFO para emitir los mensajes con uno de esos niveles.
      • getTransitionLoggingLevel

        public static LoggingLevel getTransitionLoggingLevel()
        Returns:
        the transition messages logging level
      • setTransitionLoggingLevel

        public static void setTransitionLoggingLevel​(LoggingLevel level)
        El método setTransitionLoggingLevel se utiliza para establecer el nivel de severidad de los mensajes de transición que se emiten al generar la aplicación. El valor predeterminado de esta propiedad es OFF (no emitir mensajes de transición). El método setTransitionLoggingLevel es un método estático que debe ejecutarse en el método main del proyecto maestro, antes de ejecutar el método build.
        Parameters:
        level - elemento de la enumeración LoggingLevel que determina el nivel de severidad de los mensajes de transición que se emiten al generar la aplicación. Especifique TRACE, DEBUG, INFO, WARN, ERROR o FATAL para emitir los mensajes con uno de esos niveles.
      • getSpecialExpressionLoggingLevel

        public static LoggingLevel getSpecialExpressionLoggingLevel()
        Returns:
        the special expression messages logging level
      • setSpecialExpressionLoggingLevel

        public static void setSpecialExpressionLoggingLevel​(LoggingLevel level)
        El método setSpecialExpressionLoggingLevel se utiliza para establecer el nivel de severidad de los mensajes acerca de las expresiones especiales encontradas al generar la aplicación. El valor predeterminado de esta propiedad es OFF (no emitir mensajes acerca de expresiones especiales). El método setSpecialExpressionLoggingLevel es un método estático que debe ejecutarse en el método main del proyecto maestro, antes de ejecutar el método build.
        Parameters:
        level - elemento de la enumeración LoggingLevel que determina el nivel de severidad de los mensajes acerca de expresiones especiales que se emiten al generar la aplicación. Especifique TRACE, DEBUG, INFO o WARN para emitir los mensajes con uno de esos niveles.
      • getUnusualExpressionLoggingLevel

        public static LoggingLevel getUnusualExpressionLoggingLevel()
        Returns:
        the unusual expression messages logging level
      • setUnusualExpressionLoggingLevel

        public static void setUnusualExpressionLoggingLevel​(LoggingLevel level)
        El método setUnusualExpressionLoggingLevel se utiliza para establecer el nivel de severidad de los mensajes acerca de las expresiones inusuales encontradas al generar la aplicación. El valor predeterminado de esta propiedad es WARN (emitir los mensajes como advertencias). El método setUnusualExpressionLoggingLevel es un método estático que debe ejecutarse en el método main del proyecto maestro, antes de ejecutar el método build.
        Parameters:
        level - elemento de la enumeración LoggingLevel que determina el nivel de severidad de los mensajes acerca de expresiones inusuales que se emiten al generar la aplicación. Especifique TRACE, DEBUG, INFO o WARN para emitir los mensajes con uno de esos niveles.
      • getHelpFileTypes

        public static java.lang.String[] getHelpFileTypes()
      • getHelpFileTypesCSV

        public static java.lang.String getHelpFileTypesCSV()
      • isMetaHelpEnabled

        public static boolean isMetaHelpEnabled()
      • addEntity

        public static void addEntity​(Entity entity)
      • addQueryTable

        public static void addQueryTable​(QueryTable queryTable)
      • increaseParserWarningCount

        public static void increaseParserWarningCount()
      • increaseParserErrorCount

        public static void increaseParserErrorCount()
      • logParserMessage

        public static void logParserMessage​(org.apache.log4j.Level level,
                                            java.lang.String message)
      • increaseWriterWarningCount

        public static void increaseWriterWarningCount()
      • increaseWriterErrorCount

        public static void increaseWriterErrorCount()
      • getSecondaryLocales

        public java.util.List<java.util.Locale> getSecondaryLocales()
        Returns:
        the secondary locales set
      • getSupportedLocales

        public java.util.Set<java.util.Locale> getSupportedLocales()
        Returns:
        the supported locales set
      • setSupportedLocales

        public void setSupportedLocales​(java.util.Locale... locales)
        El método setSupportedLocales se utiliza para especificar el conjunto de configuraciones regionales soportadas por el proyecto. Se genera un archivo de recursos para cada configuración regional soportada. 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. La configuración regional del archivo de recursos por defecto se especifica con el método setLocale.
        Parameters:
        locales - configuraciones regionales soportadas por el proyecto.
      • clearSupportedLocales

        public void clearSupportedLocales()
        El método clearSupportedLocales se utiliza para borrar el conjunto de configuraciones regionales soportadas por el proyecto.
      • getForeignEntityClasses

        public java.util.Set<java.lang.Class<?>> getForeignEntityClasses()
        Returns:
        the foreign entity classes set
      • setForeignEntityClasses

        public void setForeignEntityClasses​(java.util.Set<java.lang.Class<?>> classes)
        El método setForeignEntityClasses se utiliza para especificar el conjunto de clases de entidades foráneas del proyecto. Las entidades foráneas son entidades cuyas correspondientes tablas no están definidas en la base de datos del proyecto, sino en otra que tipicamente reside en un servidor diferente.
        Parameters:
        classes - clases de entidades foráneas del proyecto.
      • setForeignEntityClasses

        public void setForeignEntityClasses​(java.lang.Class<?> clazz)
        El método setForeignEntityClasses se utiliza para especificar el conjunto de clases de entidades foráneas del proyecto. Las entidades foráneas son entidades cuyas correspondientes tablas no están definidas en la base de datos del proyecto, sino en otra que tipicamente reside en un servidor diferente.
        Parameters:
        clazz - clase que contiene la declaración de clases de entidades foráneas del proyecto.
      • addForeignEntityClasses

        public void addForeignEntityClasses​(java.util.Set<java.lang.Class<?>> classes)
        El método addForeignEntityClasses se utiliza para agregar clases al conjunto de clases de entidades foráneas del proyecto. Las entidades foráneas son entidades cuyas correspondientes tablas no están definidas en la base de datos del proyecto, sino en otra que tipicamente reside en un servidor diferente.
        Parameters:
        classes - clases de entidades foráneas del proyecto.
      • addForeignEntityClasses

        public void addForeignEntityClasses​(java.lang.Class<?> clazz)
        El método addForeignEntityClasses se utiliza para agregar clases al conjunto de clases de entidades foráneas del proyecto. Las entidades foráneas son entidades cuyas correspondientes tablas no están definidas en la base de datos del proyecto, sino en otra que tipicamente reside en un servidor diferente.
        Parameters:
        clazz - clase que contiene la declaración de clases de entidades foráneas del proyecto.
      • clearForeignEntityClasses

        public void clearForeignEntityClasses()
        El método clearForeignEntityClasses se utiliza para borrar el conjunto de clases de entidades foráneas del proyecto.
      • getPrivateEntityClasses

        public java.util.Set<java.lang.Class<?>> getPrivateEntityClasses()
        Returns:
        the private entity classes set
      • setPrivateEntityClasses

        public void setPrivateEntityClasses​(java.util.Set<java.lang.Class<?>> classes)
        El método setPrivateEntityClasses se utiliza para especificar el conjunto de clases de entidades privadas del proyecto. Las entidades privadas son entidades para las que no se deben generar vistas.
        Parameters:
        classes - clases de entidades privadas del proyecto.
      • setPrivateEntityClasses

        public void setPrivateEntityClasses​(java.lang.Class<?> clazz)
        El método setPrivateEntityClasses se utiliza para especificar el conjunto de clases de entidades privadas del proyecto. Las entidades privadas son entidades para las que no se deben generar vistas.
        Parameters:
        clazz - clase que contiene la declaración de clases de entidades privadas del proyecto.
      • addPrivateEntityClasses

        public void addPrivateEntityClasses​(java.util.Set<java.lang.Class<?>> classes)
        El método addPrivateEntityClasses se utiliza para agregar clases al conjunto de clases de entidades privadas del proyecto. Las entidades privadas son entidades para las que no se deben generar vistas.
        Parameters:
        classes - clases de entidades privadas del proyecto.
      • addPrivateEntityClasses

        public void addPrivateEntityClasses​(java.lang.Class<?> clazz)
        El método addPrivateEntityClasses se utiliza para agregar clases al conjunto de clases de entidades privadas del proyecto. Las entidades privadas son entidades para las que no se deben generar vistas.
        Parameters:
        clazz - clase que contiene la declaración de clases de entidades privadas del proyecto.
      • clearPrivateEntityClasses

        public void clearPrivateEntityClasses()
        El método clearPrivateEntityClasses se utiliza para borrar el conjunto de clases de entidades privadas del proyecto.
      • getEnvironmentVariables

        public java.util.Map<java.lang.String,​java.lang.String> getEnvironmentVariables()
        Returns:
        the environment variables map
      • getEnvironmentVariable

        public java.lang.String getEnvironmentVariable​(java.lang.String key)
        Parameters:
        key - key
        Returns:
        an environment variable value
      • putEnvironmentVariable

        public java.lang.String putEnvironmentVariable​(java.lang.String key,
                                                       java.lang.String value)
        El método putEnvironmentVariable se utiliza para agregar una variable a la lista de variables de ambiente del proyecto. El método puede utilizarse repetidamente para agregar varias variables. Alternativamente, las variables de ambiente se pueden obtener del archivo private.properties mediante el método loadEnvironmentVariables. Las variables de ambiente son parejas clave/valor, de modo que si se agregan varias variables con la misma clave, el valor de tal variable será el último valor agregado.
        Parameters:
        key - clave con la que se asociará el valor especificado
        value - valor que se asociará con la clave especificada
        Returns:
        el valor anterior asociado con la clave, o nulo si no había una asignación para la clave.
      • getSlashedEnvironmentVariable

        public java.lang.String getSlashedEnvironmentVariable​(java.lang.String key)
        Parameters:
        key - key
        Returns:
        an environment variable value with all backslashes replaced by slashes
      • getBackslashedEnvironmentVariable

        public java.lang.String getBackslashedEnvironmentVariable​(java.lang.String key)
        Parameters:
        key - key
        Returns:
        an environment variable value with all slashes replaced by backslashes
      • loadEnvironmentVariables

        public void loadEnvironmentVariables()
        El método loadEnvironmentVariables se utiliza para obtener el valor de las variables de ambiente del proyecto definidas en el archivo private.properties. Las variables de ambiente son parejas clave/valor, de modo que si se agregan varias variables con la misma clave, el valor de tal variable será el último valor agregado.
      • loadEnvironmentVariables

        public void loadEnvironmentVariables​(LoggingLevel loggingLevel)
        El método loadEnvironmentVariables se utiliza para obtener el valor de las variables de ambiente del proyecto definidas en el archivo private.properties. Las variables de ambiente son parejas clave/valor, de modo que si se agregan varias variables con la misma clave, el valor de tal variable será el último valor agregado.
        Parameters:
        loggingLevel - elemento de la enumeración LoggingLevel que determina el nivel de severidad de los mensajes que se emiten al obtener el valor de las variables de ambiente del proyecto. Especifique TRACE, DEBUG, INFO, WARN, ERROR o FATAL para emitir los mensajes con ese nivel de severidad. Especifique OFF para no emitir ningún mensaje.
      • getMaster

        public Project getMaster()
        Returns:
        the master project if this is a nested project; null otherwise
      • referencesEntity

        public boolean referencesEntity​(java.lang.String classSimpleName)
        Parameters:
        classSimpleName - class simple name
        Returns:
        true if the project references an entity of a class with the specified simple name
      • referencesEntity

        public boolean referencesEntity​(java.lang.Class<?> type)
        Parameters:
        type - class
        Returns:
        true if the project references an entity of the class specified by type
      • getTypedEntity

        public <T extends Entity> T getTypedEntity​(java.lang.Class<T> type)
        getTypifiedEntity was renamed to getTypedEntity on 09/02/2023
        Type Parameters:
        T - generic class
        Parameters:
        type - entity class
        Returns:
        the root entity of the specified class
      • getEntity

        public Entity getEntity​(java.lang.Class<?> type)
        Parameters:
        type - entity class
        Returns:
        the root entity of the specified class
      • getEntity

        public Entity getEntity​(java.lang.String name)
        Parameters:
        name - entity class simple name
        Returns:
        the root entity of the specified class
      • getEntitiesList

        public java.util.List<Entity> getEntitiesList()
        Returns:
        the entities
      • getEntitiesMap

        public java.util.Map<java.lang.String,​Entity> getEntitiesMap()
        Returns:
        the entities
      • referencesModule

        public boolean referencesModule​(java.lang.String className)
        Parameters:
        className - class name
        Returns:
        true if the project references a module of a class with the specified name
      • referencesModule

        public boolean referencesModule​(java.lang.Class<?> type)
        Parameters:
        type - class
        Returns:
        true if the project references a module of the class specified by type
      • getTypedModule

        public <T extends Project> T getTypedModule​(java.lang.Class<T> type)
        Type Parameters:
        T - generic class
        Parameters:
        type - entity class
        Returns:
        the root entity of the specified class
      • getModule

        public Project getModule​(java.lang.Class<?> type)
        Parameters:
        type - class
        Returns:
        the root module of the specified class
      • getModulesList

        public java.util.List<Project> getModulesList()
        Returns:
        the modules
      • getModulesMap

        public java.util.Map<java.lang.String,​Project> getModulesMap()
        Returns:
        the modules
      • referencesProject

        public boolean referencesProject​(java.lang.String className)
        Parameters:
        className - class name
        Returns:
        true if the project references a project of a class with the specified name
      • referencesProject

        public boolean referencesProject​(java.lang.Class<?> type)
        Parameters:
        type - class
        Returns:
        true if the project references a project of the class specified by type
      • getProject

        public Project getProject​(java.lang.Class<?> type)
        Parameters:
        type - class
        Returns:
        the root project of the specified class
      • getProjectsList

        public java.util.List<Project> getProjectsList()
        Returns:
        the projects
      • getProjectsMap

        public java.util.Map<java.lang.String,​Project> getProjectsMap()
        Returns:
        the projects
      • getDisplaysList

        public java.util.List<? extends Display> getDisplaysList()
        Returns:
        the displays list
      • getDisplaysMap

        public java.util.Map<java.lang.String,​? extends Display> getDisplaysMap()
        Returns:
        the displays map
      • getConstructorsMap

        public java.util.Map<java.lang.Class<? extends Entity>,​java.util.List<ProcessOperation>> getConstructorsMap()
        Returns:
        the constructors map
      • addConstructor

        public void addConstructor​(java.lang.Class<? extends Entity> entityClass,
                                   ProcessOperation operation)
      • getCrossReferencedExpressionsSet

        public java.util.Set<java.lang.String> getCrossReferencedExpressionsSet()
        Returns:
        the cross-referenced expressions
      • containsCrossReferencedExpression

        public boolean containsCrossReferencedExpression​(Expression expression)
      • getSchemasSet

        public java.util.Set<java.lang.String> getSchemasSet()
      • getTablesMap

        public java.util.Map<java.lang.String,​java.lang.String> getTablesMap()
      • getCatalogTablesMap

        public java.util.Map<java.lang.String,​java.lang.String> getCatalogTablesMap()
      • getBusinessOperationConfirmationRequired

        public Kleenean getBusinessOperationConfirmationRequired()
        Returns:
        the business operation confirmation indicator
      • setBusinessOperationConfirmationRequired

        public void setBusinessOperationConfirmationRequired​(Kleenean confirmation)
        El método setBusinessOperationConfirmation se utiliza para especificar el valor predeterminado del elemento confirmation de la anotación OperationClass.
        Parameters:
        confirmation - TRUE para solicitar confirmación; FALSE para no solicitar confirmación.
        See Also:
        OperationClass.confirmation
      • getDatabaseOperationConfirmationRequired

        public Kleenean getDatabaseOperationConfirmationRequired()
        Returns:
        the database operation confirmation indicator
      • setDatabaseOperationConfirmationRequired

        public void setDatabaseOperationConfirmationRequired​(Kleenean confirmation)
        El método setDatabaseOperationConfirmation se utiliza para especificar el valor predeterminado del elemento confirmation de las anotaciones EntityInsertOperation, EntityUpdateOperation y EntityDeleteOperation.
        Parameters:
        confirmation - TRUE para solicitar confirmación; FALSE para no solicitar confirmación; UNSPECIFIED para utilizar el valor predeterminado. El valor predeterminado es TRUE para la operación delete, y FALSE para las demás operaciones.
        See Also:
        EntityInsertOperation.confirmation, EntityUpdateOperation.confirmation, EntityDeleteOperation.confirmation
      • isDatabaseDefaultValuesMustBeSingleEntityExpression

        public boolean isDatabaseDefaultValuesMustBeSingleEntityExpression()
        Returns:
        the database default.values.must.be.single.entity.expression indicator
      • setDatabaseDefaultValuesMustBeSingleEntityExpression

        public void setDatabaseDefaultValuesMustBeSingleEntityExpression​(boolean b)
        El método setDatabaseDefaultValuesMustBeSingleEntityExpression se utiliza para especificar si los valores por default que sean expresiones deben ser o no, expresiones de una sola entidad, para poder ser implementados en funciones de base de datos.
        Parameters:
        b - true si las expresiones deben ser de una sola entidad; de lo contrario, false
      • getMissingValueGraphicImageName

        public java.lang.String getMissingValueGraphicImageName()
        Returns:
        the missing value graphic image name of all properties
      • setMissingValueGraphicImageName

        public void setMissingValueGraphicImageName​(java.lang.String name)
        El método setMissingValueGraphicImageName se utiliza para establecer el nombre de imagen gráfica de valor requerido no especificado asociada a todas las propiedades de todas las entidades del proyecto. La imagen de la propiedad se utiliza para resaltar su valor en las vistas (páginas) de consulta y registro.
        Parameters:
        name - nombre de imagen gráfica de valor requerido no especificado asociada a las propiedades
      • isMissingValueGraphicImageNameFontAwesomeClass

        public boolean isMissingValueGraphicImageNameFontAwesomeClass()
      • getNullValueGraphicImageName

        public java.lang.String getNullValueGraphicImageName()
        Returns:
        the null value graphic image name of all properties
      • setNullValueGraphicImageName

        public void setNullValueGraphicImageName​(java.lang.String name)
        El método setNullValueGraphicImageName se utiliza para establecer el nombre de imagen gráfica de valor nulo asociada a todas las propiedades de todas las entidades del proyecto. La imagen de la propiedad se utiliza para resaltar su valor en las vistas (páginas) de consulta y registro.
        Parameters:
        name - nombre de imagen gráfica de valor nulo asociada a las propiedades
      • isNullValueGraphicImageNameFontAwesomeClass

        public boolean isNullValueGraphicImageNameFontAwesomeClass()
      • getUnnecessaryValueGraphicImageName

        public java.lang.String getUnnecessaryValueGraphicImageName()
        Returns:
        the unnecessary value graphic image name of all properties
      • setUnnecessaryValueGraphicImageName

        public void setUnnecessaryValueGraphicImageName​(java.lang.String name)
        El método setUnnecessaryValueGraphicImageName se utiliza para establecer el nombre de imagen gráfica de valor innecesario (no aplicable) asociada a todas las propiedades de todas las entidades del proyecto. La imagen de la propiedad se utiliza para resaltar su valor en las vistas (páginas) de consulta y registro.
        Parameters:
        name - nombre de imagen gráfica de valor innecesario asociada a las propiedades
      • isUnnecessaryValueGraphicImageNameFontAwesomeClass

        public boolean isUnnecessaryValueGraphicImageNameFontAwesomeClass()
      • getDefaultBooleanDisplayType

        public BooleanDisplayType getDefaultBooleanDisplayType()
        Returns:
        the default boolean display type
      • setDefaultBooleanDisplayType

        public void setDefaultBooleanDisplayType​(BooleanDisplayType type)
        El método setDefaultRequiredBooleanDisplayType se utiliza para establecer el tipo predeterminado de componente que se utiliza para mostrar el valor de propiedades Boolean que no permiten valores nulos en las vistas (páginas) de consulta y registro, y de parámetros Boolean requeridos en las vistas (páginas) de ejecución de operaciones de negocio.
        Parameters:
        type - tipo de componente Boolean
      • isAnnotatedWithMaster

        public boolean isAnnotatedWithMaster()
        Returns:
        the MasterProject annotation indicator
      • isAnnotatedWithModule

        public boolean isAnnotatedWithModule()
        Returns:
        the ProjectModule annotation indicator
      • isAnnotatedWithModuleDocGen

        public boolean isAnnotatedWithModuleDocGen()
        Returns:
        the ProjectModuleDocGen annotation indicator
      • isMenuModule

        public boolean isMenuModule()
        Returns:
        the menu module indicator
      • isRoleModule

        public boolean isRoleModule()
        Returns:
        the role module indicator
      • isForeignModule

        public boolean isForeignModule()
        Returns:
        the foreign module indicator
      • isPrivateModule

        public boolean isPrivateModule()
        Returns:
        the private module indicator
      • isDisablePrivateAndOtherContextEntitiesBplCodeGen

        public boolean isDisablePrivateAndOtherContextEntitiesBplCodeGen()
      • setDisablePrivateAndOtherContextEntitiesBplCodeGen

        public void setDisablePrivateAndOtherContextEntitiesBplCodeGen​(boolean disable)
        El método setDisablePrivateAndOtherContextEntitiesBplCodeGen se utiliza para inhabilitar la generación de código BPL (Business Process Logic) de entidades privadas y de entidades cuyas vistas (páginas) se encuentran en el módulo Web de la aplicación empresarial de otro proyecto. El método setDisablePrivateAndOtherContextEntitiesBplCodeGen debe ejecutarse en el método configureGenerator del proyecto.
        Parameters:
        disable - true o false para inhabilitar, o no, la generación de código BPL
      • isDisablePrivateAndOtherContextEntitiesBwsCodeGen

        public boolean isDisablePrivateAndOtherContextEntitiesBwsCodeGen()
      • setDisablePrivateAndOtherContextEntitiesBwsCodeGen

        public void setDisablePrivateAndOtherContextEntitiesBwsCodeGen​(boolean disable)
        El método setDisablePrivateAndOtherContextEntitiesBwsCodeGen se utiliza para inhabilitar la generación de código BWS (Business Web Service) de entidades privadas y de entidades cuyas vistas (páginas) se encuentran en el módulo Web de la aplicación empresarial de otro proyecto. El método setDisablePrivateAndOtherContextEntitiesBwsCodeGen debe ejecutarse en el método configureGenerator del proyecto.
        Parameters:
        disable - true o false para inhabilitar, o no, la generación de código BWS
      • isDisablePrivateAndOtherContextEntitiesDafCodeGen

        public boolean isDisablePrivateAndOtherContextEntitiesDafCodeGen()
      • setDisablePrivateAndOtherContextEntitiesDafCodeGen

        public void setDisablePrivateAndOtherContextEntitiesDafCodeGen​(boolean disable)
        El método setDisablePrivateAndOtherContextEntitiesDafCodeGen se utiliza para inhabilitar la generación de fachadas de acceso a datos (código DAF, por las siglas en inglés de Data Access Façade) de entidades privadas y de entidades cuyas vistas (páginas) se encuentran en el módulo Web de la aplicación empresarial de otro proyecto. El método setDisablePrivateAndOtherContextEntitiesDafCodeGen debe ejecutarse en el método configureGenerator del proyecto.
        Parameters:
        disable - true o false para inhabilitar, o no, la generación de código DAF
      • isDisablePrivateAndOtherContextEntitiesFwsCodeGen

        public boolean isDisablePrivateAndOtherContextEntitiesFwsCodeGen()
      • setDisablePrivateAndOtherContextEntitiesFwsCodeGen

        public void setDisablePrivateAndOtherContextEntitiesFwsCodeGen​(boolean disable)
        El método setDisablePrivateAndOtherContextEntitiesFwsCodeGen se utiliza para inhabilitar la generación de código FWS (Façade Web Service) de entidades privadas y de entidades cuyas vistas (páginas) se encuentran en el módulo Web de la aplicación empresarial de otro proyecto. El método setDisablePrivateAndOtherContextEntitiesFwsCodeGen debe ejecutarse en el método configureGenerator del proyecto.
        Parameters:
        disable - true o false para inhabilitar, o no, la generación de código FWS
      • getModuleMenuType

        public MenuType getModuleMenuType()
        Returns:
        the module's menu type
      • getModuleRoleTypes

        public RoleType[] getModuleRoleTypes()
        Returns:
        the module's role types
      • getModuleRoleTypesNumbers

        public int[] getModuleRoleTypesNumbers()
        Returns:
        the module's role type numbers
      • getModuleRoleTypesNumbersString

        public java.lang.String getModuleRoleTypesNumbersString()
      • getAcronym

        public java.lang.String getAcronym()
      • getHelpDocument

        public java.lang.String getHelpDocument()
        Returns:
        the help document
      • setHelpDocument

        public void setHelpDocument​(java.lang.String document)
        El método setHelpDocument se utiliza para establecer el documento incrustado de ayuda del proyecto. Cada módulo y cada entidad del proyecto podrían tener su propio documento incrustado de ayuda, según lo establecido mediante los elementos de sus anotaciones ProjectModule y EntityClass. También se puede especificar un documento incrustado diferente para cada formato de vista de cada entidad, mediante las anotaciones EntityTableView, EntityDetailView, EntityTreeView y EntityConsoleView. Las vistas utilizarán el documento incrustado definido para el correspondiente formato de vista de la entidad, la entidad de la vista, el módulo al que pertenece la entidad de la vista o el proyecto maestro, buscando en ese orden; si ninguno de ellos está definido, no habrá un documento incrustado disponible para la vista.
        Parameters:
        document - definición del documento incrustado de ayuda del proyecto; si utiliza la plataforma jee2, puede ser una URL o un iframe que incluya la URL del documento.
      • getHelpFileName

        public java.lang.String getHelpFileName()
        Returns:
        the help file name
      • setHelpFileName

        public void setHelpFileName​(java.lang.String fileName)
        El método setHelpFileName se utiliza para establecer la ruta y el nombre del archivo de ayuda del proyecto. Cada módulo, cada entidad y cada vista (página) de cada entidad del proyecto podrían tener su propio archivo de ayuda, según lo establecido mediante los elementos de las anotaciones ProjectModule y EntityClass de cada módulo y cada entidad. También se puede especificar un archivo diferente para cada formato de vista de cada entidad, mediante las anotaciones EntityTableView, EntityDetailView, EntityTreeView y EntityConsoleView. La vista que no tenga su propio archivo de ayuda utilizará el definido para el correspondiente formato de vista de la entidad, la entidad de la vista, el módulo al que pertenece la entidad de la vista o el proyecto maestro, buscando en ese orden; si ninguno de ellos está definido, la página de ayuda no estará disponible para la vista.
        Parameters:
        fileName - ruta y nombre del archivo de ayuda del proyecto; si utiliza la plataforma jee2, la ruta del archivo debe ser relativa al subdirectorio especificado mediante el atributo extraordinario HELP_RESOURCES_FOLDER del proyecto maestro, y cuyo valor por omisión es el subdirectorio resources/help/custom-made del directorio src/main/webapp del módulo Web de la aplicación.
      • getHelpFileAutoName

        public HelpFileAutoName getHelpFileAutoName()
        Returns:
        the help file auto name
      • setHelpFileAutoName

        protected void setHelpFileAutoName​(HelpFileAutoName helpFileAutoName)
      • getHelpFileAutoType

        public java.lang.String getHelpFileAutoType()
        Returns:
        the help file auto type
      • setHelpFileAutoType

        protected void setHelpFileAutoType​(java.lang.String helpFileAutoType)
      • isModuleClassDiagramGenEnabled

        public boolean isModuleClassDiagramGenEnabled()
        Returns:
        the module class diagram generation indicator
      • getEntityReferences

        public java.util.Map<java.lang.String,​ProjectEntityReference> getEntityReferences()
        Returns:
        the entity references map
      • getProjectReferences

        public java.util.Map<java.lang.String,​ProjectReference> getProjectReferences()
        Returns:
        the project references map
      • getArtifacts

        public java.util.Set<Artifact> getArtifacts()
        Returns:
        the artifacts set
      • addArtifact

        public boolean addArtifact​(Artifact artifact)
        adds an artifact to the set
        Parameters:
        artifact - artifact
        Returns:
        true if this set did not already contain the specified element
      • getAddAttributesMethods

        public java.util.Set<java.lang.reflect.Method> getAddAttributesMethods()
        Returns:
        the addAttributes methods set
      • clearAddAttributesMethods

        public void clearAddAttributesMethods()
        El método clearAddAttributesMethods se utiliza para borrar la lista de clases que contienen métodos Add Attributes.
      • attachAddAttributesMethods

        public void attachAddAttributesMethods()
      • attachAddAttributesMethods

        public void attachAddAttributesMethods​(java.lang.Class<?> clazz)
        El método attachAddAttributesMethods se utiliza para agregar una clase a la lista de clases que contienen métodos Add Attributes. El método puede utilizarse repetidamente para agregar varias clases. Para posteriormente borrar la lista se utiliza el método clearAddAttributesMethods. Todo método Add Attributes debe ser público, estático y sin valor de retorno; con un único parámetro que implemente, directa o indirectamente, la interfaz Artifact; y decorado con la anotación AddAttributesMethod. El nombre del método puede ser cualquiera que cumpla con las reglas de Java. Típicamente, un método Add Attributes agrega uno o más atributos extraordinarios, es decir, atributos propios del PSM (Platform Specific Model), al artefacto que recibe como parámetro, y/o a sus artefactos relacionados, ejecutando repetidamente el método addAttribute. Al generar el proyecto, los métodos Add Attributes de las clases agregadas son ejecutados automáticamente, para cada uno de los artefactos del proyecto, que sean asignables a partir de la clase o interfaz del parámetro, antes de ejecutar el método addAttributes propio del artefacto. El orden de ejecución de los métodos está determinado, en primer lugar, por el orden en el que se agregan las clases a la lista y, en segundo lugar, por el valor especificado en la anotación AddAttributesMethod. Si el orden de ejecución dentro de la clase no es relevante, tal valor puede ser omitido. Nótese que, dado que el método addAttributes propio de cada artefacto se ejecuta después de todos los métodos "Add Attributes" de las clases agregadas, tal método es apropiado para agregar atributos específicos del artefacto.
        Parameters:
        clazz - clase que contiene métodos Add Attributes
      • addEntityAttribute

        public void addEntityAttribute​(java.lang.String attributeName,
                                       java.lang.Object attributeValue,
                                       java.lang.Class<? extends Entity>... entityClasses)
      • setForeignEntityClass

        public void setForeignEntityClass​(java.lang.Boolean foreignEntityClass,
                                          java.lang.Class<? extends Project> moduleClass)
        El método setForeignEntityClass se utiliza para especificar un conjunto de entidades que se debe agregar, o no, al conjunto de entidades foráneas de la aplicación. Las entidades foráneas son entidades cuyas correspondientes tablas no están definidas en la base de datos de la aplicación, sino en otra que típicamente reside en un servidor diferente. El método setForeignEntityClass debe ejecutarse en el método configureAnalyzer del proyecto.
        Parameters:
        foreignEntityClass - true o false para agregar o no las entidades, respectivamente; null, para agregar las entidades solo si pertenecen a un módulo de entidades foráneas (vea el elemento foreign de la Anotación ProjectModule)
        moduleClass - clase del módulo que contiene las entidades que se van a agregar, o no, al conjunto de entidades foráneas de la aplicación
      • setForeignEntityClass

        public void setForeignEntityClass​(java.lang.Boolean foreignEntityClass,
                                          java.lang.Class<? extends Entity>... entityClasses)
        El método setForeignEntityClass se utiliza para especificar un conjunto de entidades que se debe agregar, o no, al conjunto de entidades foráneas de la aplicación. Las entidades foráneas son entidades cuyas correspondientes tablas no están definidas en la base de datos de la aplicación, sino en otra que típicamente reside en un servidor diferente. El método setForeignEntityClass debe ejecutarse en el método configureAnalyzer del proyecto.
        Parameters:
        foreignEntityClass - true o false para agregar o no las entidades, respectivamente; null, para agregar las entidades solo si pertenecen a un módulo de entidades foráneas (vea el elemento foreign de la Anotación ProjectModule)
        entityClasses - una o más clases de entidades que se van a agregar, o no, al conjunto de entidades foráneas de la aplicación
      • setPrivateEntityClass

        public void setPrivateEntityClass​(java.lang.Boolean privateEntityClass,
                                          java.lang.Class<? extends Project> moduleClass)
        El método setPrivateEntityClass se utiliza para especificar un conjunto de entidades que se debe agregar, o no, al conjunto de entidades privadas de la aplicación. Las entidades privadas son entidades para las que no se deben generar vistas. El método setPrivateEntityClass debe ejecutarse en el método configureAnalyzer del proyecto.
        Parameters:
        privateEntityClass - true o false para agregar o no las entidades, respectivamente; null, para agregar las entidades solo si pertenecen a un módulo de entidades privadas (vea el elemento private de la Anotación ProjectModule)
        moduleClass - clase del módulo que contiene las entidades que se van a agregar, o no, al conjunto de entidades privadas de la aplicación
      • setPrivateEntityClass

        public void setPrivateEntityClass​(java.lang.Boolean privateEntityClass,
                                          java.lang.Class<? extends Entity>... entityClasses)
        El método setPrivateEntityClass se utiliza para especificar un conjunto de entidades que se debe agregar, o no, al conjunto de entidades privadas de la aplicación. Las entidades privadas son entidades para las que no se deben generar vistas. El método setPrivateEntityClass debe ejecutarse en el método configureAnalyzer del proyecto.
        Parameters:
        privateEntityClass - true o false para agregar o no las entidades, respectivamente; null, para agregar las entidades solo si pertenecen a un módulo de entidades privadas (vea el elemento private de la Anotación ProjectModule)
        entityClasses - una o más clases de entidades que se van a agregar, o no, al conjunto de entidades privadas de la aplicación
      • setApplicationOrigin

        public void setApplicationOrigin​(java.lang.String origin,
                                         java.lang.Class<? extends Project> moduleClass)
        El método setApplicationOrigin se utiliza para establecer el origen de la aplicación empresarial que contiene las vistas (páginas) de un conjunto de entidades. Este atributo solo tiene efecto si el proyecto generado puede utilizar vistas (páginas) de otros proyectos. Utilice el método setMultiApplication del proyecto maestro para permitir el uso de vistas de otros proyectos. El método setApplicationOrigin debe ejecutarse en el método configureGenerator del proyecto.
        Parameters:
        origin - origen de las vistas de las entidades del conjunto definido por el siguiente parámetro; consta del protocolo, el nombre o dirección IP del servidor y el número de puerto. Por ejemplo, http://86.48.31.84:8080
        moduleClass - clase del módulo que contiene las entidades cuyo origen se va a establecer
      • setApplicationOrigin

        public void setApplicationOrigin​(java.lang.String origin,
                                         java.lang.Class<? extends Entity>... entityClasses)
        El método setApplicationOrigin se utiliza para establecer el origen de la aplicación empresarial que contiene las vistas (páginas) de un conjunto de entidades. Este atributo solo tiene efecto si el proyecto generado puede utilizar vistas (páginas) de otros proyectos. Utilice el método setMultiApplication del proyecto maestro para permitir el uso de vistas de otros proyectos. El método setApplicationOrigin debe ejecutarse en el método configureGenerator del proyecto.
        Parameters:
        origin - origen de las vistas de las entidades del conjunto definido por el siguiente parámetro; consta del protocolo, el nombre o dirección IP del servidor y el número de puerto. Por ejemplo, http://86.48.31.84:8080
        entityClasses - una o más clases de entidades cuyo origen se va a establecer
      • setApplicationContextRoot

        public void setApplicationContextRoot​(java.lang.String contextRoot,
                                              java.lang.Class<? extends Project> moduleClass)
        El método setApplicationContextRoot se utiliza para establecer la raíz de contexto del módulo Web de la aplicación empresarial que contiene las vistas (páginas) de un conjunto de entidades. Este atributo solo tiene efecto si el proyecto generado puede utilizar vistas (páginas) de otros proyectos. Utilice el método setMultiApplication del proyecto maestro para permitir el uso de vistas de otros proyectos. El método setApplicationContextRoot debe ejecutarse en el método configureGenerator del proyecto.
        Parameters:
        contextRoot - raíz de contexto del módulo Web de la aplicación que contiene las vistas de las entidades del conjunto definido por el siguiente parámetro. Por ejemplo, showcase102-web
        moduleClass - clase del módulo que contiene las entidades cuya raíz de contexto se va a establecer
      • setApplicationContextRoot

        public void setApplicationContextRoot​(java.lang.String contextRoot,
                                              java.lang.Class<? extends Entity>... entityClasses)
        El método setApplicationContextRoot se utiliza para establecer la raíz de contexto del módulo Web de la aplicación empresarial que contiene las vistas (páginas) de un conjunto de entidades. Este atributo solo tiene efecto si el proyecto generado puede utilizar vistas (páginas) de otros proyectos. Utilice el método setMultiApplication del proyecto maestro para permitir el uso de vistas de otros proyectos. El método setApplicationContextRoot debe ejecutarse en el método configureGenerator del proyecto.
        Parameters:
        contextRoot - raíz de contexto del módulo Web de la aplicación que contiene las vistas de las entidades del conjunto definido por el siguiente parámetro. Por ejemplo, showcase102-web
        entityClasses - una o más clases de entidades cuya raíz de contexto se va a establecer
      • setApplicationConsolePath

        public void setApplicationConsolePath​(java.lang.String consolePath,
                                              java.lang.Class<? extends Project> moduleClass)
        El método setApplicationConsolePath se utiliza para establecer la parte intermedia del path de las vistas (páginas) de procesamiento de un conjunto de entidades. El método setApplicationConsolePath debe ejecutarse en el método configureGenerator del proyecto.
        Parameters:
        consolePath - parte intermedia del path de las vistas (páginas) de procesamiento de las entidades del conjunto definido por el siguiente parámetro. Por ejemplo, faces/views/base/crop/procesamiento
        moduleClass - clase del módulo que contiene las entidades cuya parte intermedia del path se va a establecer
      • setApplicationConsolePath

        public void setApplicationConsolePath​(java.lang.String consolePath,
                                              java.lang.Class<? extends Entity>... entityClasses)
        El método setApplicationConsolePath se utiliza para establecer la parte intermedia del path de las vistas (páginas) de procesamiento de un conjunto de entidades. El método setApplicationConsolePath debe ejecutarse en el método configureGenerator del proyecto.
        Parameters:
        consolePath - parte intermedia del path de las vistas (páginas) de procesamiento de las entidades del conjunto definido por el siguiente parámetro. Por ejemplo, faces/views/base/crop/procesamiento
        entityClasses - una o más clases de entidades cuya parte intermedia del path se va a establecer
      • setApplicationReadingPath

        public void setApplicationReadingPath​(java.lang.String readingPath,
                                              java.lang.Class<? extends Project> moduleClass)
        El método setApplicationReadingPath se utiliza para establecer la parte intermedia del path de las vistas (páginas) de consulta de un conjunto de entidades. El método setApplicationReadingPath debe ejecutarse en el método configureGenerator del proyecto.
        Parameters:
        readingPath - parte intermedia del path de las vistas (páginas) de consulta de las entidades del conjunto definido por el siguiente parámetro. Por ejemplo, faces/views/base/crop/consulta
        moduleClass - clase del módulo que contiene las entidades cuya parte intermedia del path se va a establecer
      • setApplicationReadingPath

        public void setApplicationReadingPath​(java.lang.String readingPath,
                                              java.lang.Class<? extends Entity>... entityClasses)
        El método setApplicationReadingPath se utiliza para establecer la parte intermedia del path de las vistas (páginas) de consulta de un conjunto de entidades. El método setApplicationReadingPath debe ejecutarse en el método configureGenerator del proyecto.
        Parameters:
        readingPath - parte intermedia del path de las vistas (páginas) de consulta de las entidades del conjunto definido por el siguiente parámetro. Por ejemplo, faces/views/base/crop/consulta
        entityClasses - una o más clases de entidades cuya parte intermedia del path se va a establecer
      • setApplicationWritingPath

        public void setApplicationWritingPath​(java.lang.String writingPath,
                                              java.lang.Class<? extends Project> moduleClass)
        El método setApplicationWritingPath se utiliza para establecer la parte intermedia del path de las vistas (páginas) de registro de un conjunto de entidades. El método setApplicationWritingPath debe ejecutarse en el método configureGenerator del proyecto.
        Parameters:
        writingPath - parte intermedia del path de las vistas (páginas) de registro de las entidades del conjunto definido por el siguiente parámetro. Por ejemplo, faces/views/base/crop/registro
        moduleClass - clase del módulo que contiene las entidades cuya parte intermedia del path se va a establecer
      • setApplicationWritingPath

        public void setApplicationWritingPath​(java.lang.String writingPath,
                                              java.lang.Class<? extends Entity>... entityClasses)
        El método setApplicationWritingPath se utiliza para establecer la parte intermedia del path de las vistas (páginas) de registro de un conjunto de entidades. El método setApplicationWritingPath debe ejecutarse en el método configureGenerator del proyecto.
        Parameters:
        writingPath - parte intermedia del path de las vistas (páginas) de registro de las entidades del conjunto definido por el siguiente parámetro. Por ejemplo, faces/views/base/crop/registro
        entityClasses - una o más clases de entidades cuya parte intermedia del path se va a establecer
      • setBplCodeGenEnabled

        public void setBplCodeGenEnabled​(boolean enabled,
                                         java.lang.Class<? extends Project> moduleClass)
        El método setBplCodeGenEnabled se utiliza para especificar si se debe, o no, generar código BPL (Business Process Logic) para un conjunto de entidades. El método setBplCodeGenEnabled debe ejecutarse en el método configureGenerator del proyecto.
        Parameters:
        enabled - true o false para generar, o no, código BPL para las entidades del conjunto definido por el parámetro moduleClass
        moduleClass - clase del módulo que contiene las entidades cuya generación de código BPL se va a establecer
      • setBplCodeGenEnabled

        public void setBplCodeGenEnabled​(boolean enabled,
                                         boolean updateOnlyEntities,
                                         java.lang.Class<? extends Project> moduleClass)
        El método setBplCodeGenEnabled se utiliza para especificar si se debe, o no, generar código BPL (Business Process Logic) para un conjunto de entidades.El método setBplCodeGenEnabled debe ejecutarse en el método configureGenerator del proyecto.
        Parameters:
        enabled - true o false para generar, o no, código BPL para las entidades del conjunto definido por el parámetro moduleClass
        updateOnlyEntities - true para actualizar solo las entidades; o false, para actualizar el atributo de las entidades y sus operaciones
        moduleClass - clase del módulo que contiene las entidades cuya generación de código BPL se va a establecer
      • setBplCodeGenEnabled

        public void setBplCodeGenEnabled​(boolean enabled,
                                         java.lang.Class<? extends Entity>... entityClasses)
        El método setBplCodeGenEnabled se utiliza para especificar si se debe, o no, generar código BPL (Business Process Logic) para un conjunto de entidades. El método setBplCodeGenEnabled debe ejecutarse en el método configureGenerator del proyecto.
        Parameters:
        enabled - true o false para generar, o no, código BPL para las entidades del conjunto definido por el parámetro entityClasses
        entityClasses - una o más clases de entidades cuya generación de código BPL se va a establecer
      • setBplCodeGenEnabled

        public void setBplCodeGenEnabled​(boolean enabled,
                                         boolean updateOnlyEntities,
                                         java.lang.Class<? extends Entity>... entityClasses)
        El método setBplCodeGenEnabled se utiliza para especificar si se debe, o no, generar código BPL (Business Process Logic) para un conjunto de entidades. El método setBplCodeGenEnabled debe ejecutarse en el método configureGenerator del proyecto.
        Parameters:
        enabled - true o false para generar, o no, código BPL para las entidades del conjunto definido por el parámetro entityClasses
        updateOnlyEntities - true para actualizar solo las entidades; o false, para actualizar el atributo de las entidades y sus operaciones
        entityClasses - una o más clases de entidades cuya generación de código BPL se va a establecer
      • setBwsCodeGenEnabled

        public void setBwsCodeGenEnabled​(boolean enabled,
                                         java.lang.Class<? extends Project> moduleClass)
        El método setBwsCodeGenEnabled se utiliza para especificar si se debe, o no, generar código BWS (Business Web Service) para un conjunto de entidades. El método setBwsCodeGenEnabled debe ejecutarse en el método configureGenerator del proyecto.
        Parameters:
        enabled - true o false para generar, o no, código BWS para las entidades del conjunto definido por el parámetro moduleClass
        moduleClass - clase del módulo que contiene las entidades cuya generación de código BWS se va a establecer
      • setBwsCodeGenEnabled

        public void setBwsCodeGenEnabled​(boolean enabled,
                                         java.lang.Class<? extends Entity>... entityClasses)
        El método setBwsCodeGenEnabled se utiliza para especificar si se debe, o no, generar código BWS (Business Web Service) para un conjunto de entidades. El método setBwsCodeGenEnabled debe ejecutarse en el método configureGenerator del proyecto.
        Parameters:
        enabled - true o false para generar, o no, código BWS para las entidades del conjunto definido por el parámetro entityClasses
        entityClasses - una o más clases de entidades cuya generación de código BWS se va a establecer
      • setDafCodeGenEnabled

        public void setDafCodeGenEnabled​(boolean enabled,
                                         java.lang.Class<? extends Project> moduleClass)
        El método setDafCodeGenEnabled se utiliza para especificar si se debe, o no, generar una fachada de acceso a datos (código DAF, por las siglas en inglés de Data Access Façade) para un conjunto de entidades. El método setDafCodeGenEnabled debe ejecutarse en el método configureGenerator del proyecto.
        Parameters:
        enabled - true o false para generar, o no, código DAF para las entidades del conjunto definido por el parámetro moduleClass
        moduleClass - clase del módulo que contiene las entidades cuya generación de código DAF se va a establecer
      • setDafCodeGenEnabled

        public void setDafCodeGenEnabled​(boolean enabled,
                                         java.lang.Class<? extends Entity>... entityClasses)
        El método setDafCodeGenEnabled se utiliza para especificar si se debe, o no, generar una fachada de acceso a datos (código DAF, por las siglas en inglés de Data Access Façade) para un conjunto de entidades. El método setDafCodeGenEnabled debe ejecutarse en el método configureGenerator del proyecto.
        Parameters:
        enabled - true o false para generar, o no, código DAF para las entidades del conjunto definido por el parámetro entityClasses
        entityClasses - una o más clases de entidades cuya generación de código DAF se va a establecer
      • setFwsCodeGenEnabled

        public void setFwsCodeGenEnabled​(boolean enabled,
                                         java.lang.Class<? extends Project> moduleClass)
        El método setFwsCodeGenEnabled se utiliza para especificar si se debe, o no, generar código FWS (Façade Web Service) para un conjunto de entidades. El método setFwsCodeGenEnabled debe ejecutarse en el método configureGenerator del proyecto.
        Parameters:
        enabled - true o false para generar, o no, código FWS para las entidades del conjunto definido por el parámetro moduleClass
        moduleClass - clase del módulo que contiene las entidades cuya generación de código FWS se va a establecer
      • setFwsCodeGenEnabled

        public void setFwsCodeGenEnabled​(boolean enabled,
                                         java.lang.Class<? extends Entity>... entityClasses)
        El método setFwsCodeGenEnabled se utiliza para especificar si se debe, o no, generar código FWS (Façade Web Service) para un conjunto de entidades. El método setFwsCodeGenEnabled debe ejecutarse en el método configureGenerator del proyecto.
        Parameters:
        enabled - true o false para generar, o no, código FWS para las entidades del conjunto definido por el parámetro entityClasses
        entityClasses - una o más clases de entidades cuya generación de código FWS se va a establecer
      • getProcessingGroups

        public java.util.Set<java.lang.String> getProcessingGroups()
        Returns:
        the processing groups set
      • getUserFlows

        public java.util.Set<UserFlow> getUserFlows()
        Returns:
        the user flows set
      • evaluateEntity

        public boolean evaluateEntity​(java.lang.String entityName,
                                      java.lang.String predicateName)
      • getUploadedFileEntityClass

        public java.lang.Class<? extends Entity> getUploadedFileEntityClass()
      • getUserEntityClass

        public java.lang.Class<? extends Entity> getUserEntityClass()
      • unsetSpecialEntityClasses

        public java.util.List<java.lang.Class<? extends Entity>> unsetSpecialEntityClasses()
      • getSpecialNativeQuerySegments

        public java.util.List<NativeQuerySegment> getSpecialNativeQuerySegments​(Entity entity)
      • loadPrivateProperties

        public void loadPrivateProperties()
        El método loadPrivateProperties se utiliza para obtener el valor de las variables del proyecto (sin incluir las variables de ambiente, las cuales se obtienen con el método loadEnvironmentVariables) definidas en el archivo private.properties. Las variables del proyecto son parejas clave/valor, de modo que si se agregan varias variables con la misma clave, el valor de tal variable será el último valor agregado.
      • loadPrivateProperties

        public void loadPrivateProperties​(LoggingLevel loggingLevel)
        El método loadPrivateProperties se utiliza para obtener el valor de las variables del proyecto (sin incluir las variables de ambiente, las cuales se obtienen con el método loadEnvironmentVariables) definidas en el archivo private.properties. Las variables del proyecto son parejas clave/valor, de modo que si se agregan varias variables con la misma clave, el valor de tal variable será el último valor agregado.
        Parameters:
        loggingLevel - elemento de la enumeración LoggingLevel que determina el nivel de severidad de los mensajes que se emiten al obtener el valor de las variables del proyecto. Especifique TRACE, DEBUG, INFO, WARN, ERROR o FATAL para emitir los mensajes con ese nivel de severidad. Especifique OFF para no emitir ningún mensaje.
      • loadPrivateProperties

        protected void loadPrivateProperties​(LoggingLevel loggingLevel,
                                             org.apache.commons.collections.ExtendedProperties properties)
      • loadPrivateProperties

        protected void loadPrivateProperties​(org.apache.log4j.Level level,
                                             org.apache.commons.collections.ExtendedProperties properties)
      • settleAttributes

        protected void settleAttributes()
      • clearDirectives

        public void clearDirectives()
        El método clearDirectives se utiliza para borrar la lista de directrices del proyecto.
      • addDirectives

        public void addDirectives()
        Adds the platform-specific directives
      • addFileExclusionPattern

        public void addFileExclusionPattern​(java.lang.String regex)
        El método addFileExclusionPattern se utiliza para agregar una directriz de exclusión de archivos a la lista de directrices del proyecto. El método puede utilizarse repetidamente para agregar varias directrices. Al ejecutar el proyecto Maestro, no se generarán aquellos archivos cuyos nombres satisfacen alguna de las directrices de exclusión del proyecto; más aún, se eliminarán los archivos previamente generados cuyos nombres satisfacen alguna de tales directrices.
        Parameters:
        regex - expresión regular para evaluar el nombre de los archivos que se deben excluir
      • addFilePreservationPattern

        public void addFilePreservationPattern​(java.lang.String regex)
        El método addFilePreservationPattern se utiliza para agregar una directriz de preservación de archivos a la lista de directrices del proyecto. El método puede utilizarse repetidamente para agregar varias directrices. Al ejecutar el proyecto Maestro, no se generarán aquellos archivos que ya existen y cuyos nombres satisfacen alguna de las directrices de preservación del proyecto.
        Parameters:
        regex - expresión regular para evaluar el nombre de los archivos que se deben preservar
      • getValidTypeAnnotations

        protected java.util.List<java.lang.Class<? extends java.lang.annotation.Annotation>> getValidTypeAnnotations()
        Overrides:
        getValidTypeAnnotations in class AbstractArtifact
      • getValidFieldAnnotations

        protected java.util.List<java.lang.Class<? extends java.lang.annotation.Annotation>> getValidFieldAnnotations()
        Overrides:
        getValidFieldAnnotations in class AbstractArtifact
      • build

        public boolean build​(java.lang.String platform)
        Specified by:
        build in interface ProjectBuilder
      • build

        public boolean build()
      • getBuildTimestamp

        public java.lang.String getBuildTimestamp()
      • getBuildDate

        public java.lang.String getBuildDate()
      • getAdalidProjectVersion

        public java.lang.String getAdalidProjectVersion()
      • logAdalidProjectVersion

        protected void logAdalidProjectVersion()
      • configureBuilder

        public void configureBuilder()
        set builder settings
      • parse

        protected boolean parse()
      • analyze

        protected boolean analyze()
      • assemble

        protected boolean assemble()
      • generate

        public boolean generate​(java.lang.String platform)
      • disablePrivateAndOtherContextEntitiesCodeGen

        protected void disablePrivateAndOtherContextEntitiesCodeGen()
      • isOptionalBplCodeGen

        protected boolean isOptionalBplCodeGen​(Entity entity)
      • isOptionalDafCodeGen

        protected boolean isOptionalDafCodeGen​(Entity entity)
      • afterWriting

        protected boolean afterWriting​(boolean ok)
      • printSummary

        protected void printSummary​(boolean ok)
      • configureAnalyzer

        public void configureAnalyzer()
        set analyzer settings
      • configureGenerator

        public void configureGenerator()
        set generator settings
      • readyToWrite

        protected boolean readyToWrite​(java.lang.String platform)
      • getDisplayOf

        public Display getDisplayOf​(java.lang.String name)
      • getReadingTableDisplayOf

        public Display getReadingTableDisplayOf​(Entity entity)
      • getReadingDetailDisplayOf

        public Display getReadingDetailDisplayOf​(Entity entity)
      • getReadingTreeDisplayOf

        public Display getReadingTreeDisplayOf​(Entity entity)
      • getWritingTableDisplayOf

        public Display getWritingTableDisplayOf​(Entity entity)
      • getWritingDetailDisplayOf

        public Display getWritingDetailDisplayOf​(Entity entity)
      • getWritingTreeDisplayOf

        public Display getWritingTreeDisplayOf​(Entity entity)
      • getProcessingConsoleDisplayOf

        public Display getProcessingConsoleDisplayOf​(Entity entity)
      • getTableSiblingOf

        public Display getTableSiblingOf​(Display display)
      • getDetailSiblingOf

        public Display getDetailSiblingOf​(Display display)
      • getTreeSiblingOf

        public Display getTreeSiblingOf​(Display display)
      • getConsoleSiblingOf

        public Display getConsoleSiblingOf​(Display display)
      • getTableCousinOf

        public Display getTableCousinOf​(Display display)
      • getDetailCousinOf

        public Display getDetailCousinOf​(Display display)
      • getTreeCousinOf

        public Display getTreeCousinOf​(Display display)
      • getConsoleCousinOf

        public Display getConsoleCousinOf​(Display display)
      • getLocallyDeclaredEntityClasses

        public java.util.Set<java.lang.Class<?>> getLocallyDeclaredEntityClasses()
      • getLocallyDeclaredEntityClassSimpleNames

        public java.util.Set<java.lang.String> getLocallyDeclaredEntityClassSimpleNames()
      • getLocallyDeclaredEntityClassSimpleNamesArray

        public java.lang.String[] getLocallyDeclaredEntityClassSimpleNamesArray()
      • increaseWarningCount

        protected void increaseWarningCount()
      • increaseErrorCount

        protected void increaseErrorCount()
      • increaseWriterWarnings

        protected void increaseWriterWarnings​(int count)
      • increaseWriterErrors

        protected void increaseWriterErrors​(int count)
      • iframe

        protected static java.lang.String iframe​(java.lang.String src)
        Cree la definición de un iframe usando MessageFormat.format

        Parameters:
        src - URL del documento a incrustar en el iframe
        Returns:
        la definición de un iframe de 300 x 150 píxeles
      • iframe

        protected static java.lang.String iframe​(java.lang.String src,
                                                 int width,
                                                 int height)
        Cree la definición de un iframe usando MessageFormat.format

        Parameters:
        src - URL del documento a incrustar en el iframe
        width - ancho del iframe en píxeles. Un número menor o igual a 0 es equivalente a 300; un número mayor que 0 y menor que 100 es equivalente a 100.
        height - alto del iframe en píxeles. Un número menor o igual a 0 es equivalente a 150; un número mayor que 0 y menor que 50 es equivalente a 50.
        Returns:
        la definición de un iframe
      • compareTo

        public int compareTo​(Project o)
        Specified by:
        compareTo in interface java.lang.Comparable<Project>
      • print

        public void print()
      • fieldsToString

        protected java.lang.String fieldsToString​(int n,
                                                  java.lang.String key,
                                                  boolean verbose,
                                                  boolean fields,
                                                  boolean maps)
        Overrides:
        fieldsToString in class AbstractArtifact
      • mapsToString

        protected java.lang.String mapsToString​(int n,
                                                java.lang.String key,
                                                boolean verbose,
                                                boolean fields,
                                                boolean maps)
        Overrides:
        mapsToString in class AbstractArtifact