Package adalid.core.interfaces

Interface Artifact

    • Method Detail

      • isAnnotated

        boolean isAnnotated()
        Returns:
        true if the artifact is annotated

      • isDeclared

        boolean isDeclared()
        Returns:
        true if the artifact is declared

      • isNotDeclared

        boolean isNotDeclared()
        Returns:
        true if the artifact is not declared

      • isInherited

        boolean isInherited()
        Returns:
        true if the artifact is inherited

      • isNotInherited

        boolean isNotInherited()
        Returns:
        true if the artifact is not inherited

      • isInheritedFromAbstract

        boolean isInheritedFromAbstract()
        Returns:
        true if the artifact is inherited from an abstract class

      • isNotInheritedFromAbstract

        boolean isNotInheritedFromAbstract()
        Returns:
        true if the artifact is not inherited from an abstract class

      • isInheritedFromConcrete

        boolean isInheritedFromConcrete()
        Returns:
        true if the artifact is inherited from a concrete class

      • isNotInheritedFromConcrete

        boolean isNotInheritedFromConcrete()
        Returns:
        true if the artifact is not inherited from a concrete class

      • getName

        String getName()
        Returns:
        the name

      • getAlias

        String getAlias()
        Returns:
        the alias

      • setAlias

        void setAlias​(String alias)
        El método setAlias se utiliza para establecer el alias (código alterno) del proyecto. El alias solo puede contener letras minúsculas y números, debe comenzar por una letra, y no puede ser jee2ap101, meta o workspace. Se recomienda utilizar un alias que tenga el nombre de su proyecto como prefijo. Si utiliza la plataforma jee2, el alias del proyecto maestro es el nombre del directorio raíz de los archivos generados; por lo tanto, se debe establecer un alias diferente antes de cada ejecución del método generate.
        Parameters:
        alias - código alterno del proyecto

      • getSqlName

        String getSqlName()
        Returns:
        the SQL name

      • setSqlName

        void setSqlName​(String sqlName)
        El método setSqlName se utiliza para establecer el nombre SQL del artefacto. Si este método no es ejecutado, el nombre SQL se determina a partir del nombre del artefacto, sustituyendo cada letra mayúscula por un guion bajo (underscore) seguido de la letra convertida en minúscula.
        Parameters:
        sqlName - nombre SQL del artefacto

      • getDefaultLocale

        Locale getDefaultLocale()
        Returns:
        the default locale

      • getDefaultLabel

        String getDefaultLabel()
        Returns:
        the default label

      • setDefaultLabel

        void setDefaultLabel​(String defaultLabel)
        El método setDefaultLabel se utiliza para establecer la etiqueta del artefacto que se almacena en el archivo de recursos por defecto. En caso de que el archivo de recursos para el idioma seleccionado por el usuario no esté disponible, la interfaz de la aplicación utiliza el archivo de recursos por defecto para obtener el valor de la etiqueta.
        Parameters:
        defaultLabel - sustantivo singular que se usa como etiqueta del artefacto

      • getDefaultShortLabel

        String getDefaultShortLabel()
        Returns:
        the default short label

      • setDefaultShortLabel

        void setDefaultShortLabel​(String defaultShortLabel)
        El método setDefaultShortLabel se utiliza para establecer la etiqueta corta del artefacto que se almacena en el archivo de recursos por defecto. En caso de que el archivo de recursos para el idioma seleccionado por el usuario no esté disponible, la interfaz de la aplicación utiliza el archivo de recursos por defecto para obtener el valor de la etiqueta.
        Parameters:
        defaultShortLabel - sustantivo singular, preferiblemente sin complementos, que se usa como etiqueta corta del artefacto

      • getDefaultCollectionLabel

        String getDefaultCollectionLabel()
        Returns:
        the default collection label

      • setDefaultCollectionLabel

        void setDefaultCollectionLabel​(String defaultCollectionLabel)
        El método setDefaultCollectionLabel se utiliza para establecer la etiqueta de colección del artefacto que se almacena en el archivo de recursos por defecto. En caso de que el archivo de recursos para el idioma seleccionado por el usuario no esté disponible, la interfaz de la aplicación utiliza el archivo de recursos por defecto para obtener el valor de la etiqueta.
        Parameters:
        defaultCollectionLabel - sustantivo plural que se usa como etiqueta de colección del artefacto

      • getDefaultCollectionShortLabel

        String getDefaultCollectionShortLabel()
        Returns:
        the default collection short label

      • setDefaultCollectionShortLabel

        void setDefaultCollectionShortLabel​(String defaultCollectionShortLabel)
        El método setDefaultCollectionShortLabel se utiliza para establecer la etiqueta corta de colección del artefacto que se almacena en el archivo de recursos por defecto. En caso de que el archivo de recursos para el idioma seleccionado por el usuario no esté disponible, la interfaz de la aplicación utiliza el archivo de recursos por defecto para obtener el valor de la etiqueta.
        Parameters:
        defaultCollectionShortLabel - sustantivo plural, preferiblemente sin complementos, que se usa como etiqueta corta de colección del artefacto

      • getDefaultDescription

        String getDefaultDescription()
        Returns:
        the default description

      • setDefaultDescription

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

      • getDefaultShortDescription

        String getDefaultShortDescription()
        Returns:
        the default short description

      • setDefaultShortDescription

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

      • getDefaultTooltip

        String getDefaultTooltip()
        Returns:
        the default tooltip

      • setDefaultTooltip

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

      • getDefaultSymbol

        String getDefaultSymbol()
        Returns:
        the default symbol

      • setDefaultSymbol

        void setDefaultSymbol​(String defaultSymbol)
        El método setDefaultSymbol se utiliza para establecer el símbolo o unidad del artefacto que se almacena en el archivo de recursos por defecto. En caso de que el archivo de recursos para el idioma seleccionado por el usuario no esté disponible, la interfaz de la aplicación utiliza el archivo de recursos por defecto para obtener el valor del símbolo.
        Parameters:
        defaultSymbol - una o más oraciones que describen muy brevemente el artefacto

      • getLocalizedLabel

        String getLocalizedLabel​(Locale locale)
        Parameters:
        locale - locale
        Returns:
        the localized label

      • setLocalizedLabel

        void setLocalizedLabel​(Locale locale,
                       String localizedLabel)
        El método setLocalizedLabel se utiliza para establecer la etiqueta del artefacto que se almacena en el archivo de recursos de configuración regional. En caso de que el archivo de recursos para el idioma seleccionado por el usuario no esté disponible, la interfaz de la aplicación utiliza el archivo de recursos por defecto para obtener el valor de la etiqueta.
        Parameters:
        locale - configuración regional
        localizedLabel - sustantivo singular que se usa como etiqueta del artefacto

      • getLocalizedShortLabel

        String getLocalizedShortLabel​(Locale locale)
        Parameters:
        locale - locale
        Returns:
        the localized short label

      • setLocalizedShortLabel

        void setLocalizedShortLabel​(Locale locale,
                            String localizedShortLabel)
        El método setLocalizedShortLabel se utiliza para establecer la etiqueta corta del artefacto que se almacena en el archivo de recursos de configuración regional. En caso de que el archivo de recursos para el idioma seleccionado por el usuario no esté disponible, la interfaz de la aplicación utiliza el archivo de recursos por defecto para obtener el valor de la etiqueta.
        Parameters:
        locale - configuración regional
        localizedShortLabel - sustantivo singular, preferiblemente sin complementos, que se usa como etiqueta corta del artefacto

      • getLocalizedCollectionLabel

        String getLocalizedCollectionLabel​(Locale locale)
        Parameters:
        locale - locale
        Returns:
        the localized collection label

      • setLocalizedCollectionLabel

        void setLocalizedCollectionLabel​(Locale locale,
                                 String localizedCollectionLabel)
        El método setLocalizedCollectionLabel se utiliza para establecer la etiqueta de colección del artefacto que se almacena en el archivo de recursos de configuración regional. En caso de que el archivo de recursos para el idioma seleccionado por el usuario no esté disponible, la interfaz de la aplicación utiliza el archivo de recursos por defecto para obtener el valor de la etiqueta.
        Parameters:
        locale - configuración regional
        localizedCollectionLabel - sustantivo plural que se usa como etiqueta de colección del artefacto

      • getLocalizedCollectionShortLabel

        String getLocalizedCollectionShortLabel​(Locale locale)
        Parameters:
        locale - locale
        Returns:
        the localized collection short label

      • setLocalizedCollectionShortLabel

        void setLocalizedCollectionShortLabel​(Locale locale,
                                      String localizedCollectionShortLabel)
        El método setLocalizedCollectionShortLabel se utiliza para establecer la etiqueta corta de colección del artefacto que se almacena en el archivo de recursos de configuración regional. En caso de que el archivo de recursos para el idioma seleccionado por el usuario no esté disponible, la interfaz de la aplicación utiliza el archivo de recursos por defecto para obtener el valor de la etiqueta.
        Parameters:
        locale - configuración regional
        localizedCollectionShortLabel - sustantivo plural, preferiblemente sin complementos, que se usa como etiqueta corta de colección del artefacto

      • getLocalizedDescription

        String getLocalizedDescription​(Locale locale)
        Parameters:
        locale - locale
        Returns:
        the localized description

      • setLocalizedDescription

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

      • getLocalizedShortDescription

        String getLocalizedShortDescription​(Locale locale)
        Parameters:
        locale - locale
        Returns:
        the localized short description

      • setLocalizedShortDescription

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

      • getLocalizedTooltip

        String getLocalizedTooltip​(Locale locale)
        Parameters:
        locale - locale
        Returns:
        the localized tooltip

      • setLocalizedTooltip

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

      • getLocalizedSymbol

        String getLocalizedSymbol​(Locale locale)
        Parameters:
        locale - locale
        Returns:
        the localized symbol

      • setLocalizedSymbol

        void setLocalizedSymbol​(Locale locale,
                        String localizedSymbol)
        El método setLocalizedSymbol se utiliza para establecer el símbolo o unidad del artefacto que se almacena en el archivo de recursos de configuración regional. En caso de que el archivo de recursos para el idioma seleccionado por el usuario no esté disponible, la interfaz de la aplicación utiliza el archivo de recursos por defecto para obtener el valor del símbolo.
        Parameters:
        locale - configuración regional
        localizedSymbol - una o más oraciones que describen muy brevemente el artefacto

      • getDeclaringArtifact

        Artifact getDeclaringArtifact()
        Returns:
        the declaring artifact

      • getDeclaringField

        Field getDeclaringField()
        Returns:
        the declaring field

      • getDeclaringFieldIndex

        int getDeclaringFieldIndex()
        Returns:
        the declaring field index

      • getDeclaringEntity

        Entity getDeclaringEntity()
        Returns:
        the declaring entity if the artifact directly declared by one, null otherwise

      • getDeclaringEntityRoot

        Entity getDeclaringEntityRoot()
        Returns:
        the declaring entity if the artifact directly declared by one, null otherwise

      • getDeclaringPersistentEntity

        PersistentEntity getDeclaringPersistentEntity()
        Returns:
        the declaring entity if the artifact directly declared by one, null otherwise

      • getDeclaringPersistentEntityRoot

        PersistentEntity getDeclaringPersistentEntityRoot()
        Returns:
        the declaring entity if the artifact directly declared by one, null otherwise

      • getDeclaringFieldEntityRoot

        Entity getDeclaringFieldEntityRoot()
        Returns:
        the declaring entity if the artifact directly declared by one, null otherwise

      • getDeclaringFieldPersistentEntityRoot

        PersistentEntity getDeclaringFieldPersistentEntityRoot()
        Returns:
        the declaring entity if the artifact directly declared by one, null otherwise

      • getDeclaringFieldPersistentEntityTableRoot

        PersistentEntity getDeclaringFieldPersistentEntityTableRoot()
        Returns:
        the declaring entity if the artifact directly declared by one, null otherwise

      • getDeclaringOperation

        Operation getDeclaringOperation()
        Returns:
        the declaring operation if the artifact directly declared by one, null otherwise

      • depth

        int depth()
        Returns:
        the depth

      • round

        int round()
        Returns:
        the round

      • put

        Field put​(Class<? extends Annotation> annotation,
          Field field)
        Parameters:
        annotation - annotation
        field - field
        Returns:
        field

      • clearAttributes

        void clearAttributes()

      • addAttributes

        void addAttributes()

      • addAttribute

        Object addAttribute​(Class<?> clazz,
                    String name,
                    KVP value)
        Parameters:
        clazz - class
        name - name
        value - value
        Returns:
        object

      • addAttribute

        Object addAttribute​(String name,
                    KVP value)
        Parameters:
        name - name
        value - value
        Returns:
        object

      • addAttribute

        Object addAttribute​(Class<?> clazz,
                    String name,
                    KVP... value)
        Parameters:
        clazz - class
        name - name
        value - value
        Returns:
        object

      • addAttribute

        Object addAttribute​(String name,
                    KVP... value)
        Parameters:
        name - name
        value - value
        Returns:
        object

      • addAttribute

        Object addAttribute​(Class<?> clazz,
                    String name,
                    Object value)
        Parameters:
        clazz - class
        name - name
        value - value
        Returns:
        object

      • addAttribute

        Object addAttribute​(String name,
                    Object value)
        Parameters:
        name - name
        value - value
        Returns:
        object

      • addAttribute

        Object addAttribute​(Class<?> clazz,
                    String name,
                    Object... value)
        Parameters:
        clazz - class
        name - name
        value - value
        Returns:
        object

      • addAttribute

        Object addAttribute​(String name,
                    Object... value)
        Parameters:
        name - name
        value - value
        Returns:
        object

      • getAttribute

        Object getAttribute​(Class<?> clazz,
                    String name)
        Parameters:
        clazz - class
        name - name
        Returns:
        object

      • getAttribute

        Object getAttribute​(String name)
        Parameters:
        name - name
        Returns:
        object

      • getClassPath

        String getClassPath()
        Returns:
        the class path

      • isClassInPath

        boolean isClassInPath​(Class<?> type)
        Parameters:
        type - class to test
        Returns:
        true if type is present in the class path

      • getPathList

        List<Artifact> getPathList()
        Returns:
        the path

      • getPathString

        String getPathString()
        Returns:
        the path string

      • getFullName

        String getFullName()
        Returns:
        the full name

      • getPartialName

        String getPartialName()
        Returns:
        the partial name

      • isOperation

        boolean isOperation()
        Returns:
        true if this artifact is an Operation; otherwise false

      • isExpression

        boolean isExpression()
        Returns:
        true if this artifact is an Expression; otherwise false

      • isFinalised

        boolean isFinalised()
        Returns:
        true if this artifact is already finalised; otherwise false

      • finalise

        boolean finalise()
        dot the i's and cross the t's
        Returns:
        true if this artifact was successfully finalised; otherwise false

      • hashCodeHexString

        String hashCodeHexString()
        Returns:
        the hex string representation of the hash code

      • toString

        String toString​(int n)
        Parameters:
        n - n
        Returns:
        the string representation of the data

      • toString

        String toString​(int n,
                String key)
        Parameters:
        n - n
        key - key
        Returns:
        the string representation of the data

      • toString

        String toString​(int n,
                String key,
                boolean verbose)
        Parameters:
        n - n
        key - key
        verbose - verbose
        Returns:
        the string representation of the data

      • toString

        String toString​(int n,
                String key,
                boolean verbose,
                boolean fields,
                boolean maps)
        Parameters:
        n - n
        key - key
        verbose - verbose
        fields - fields
        maps - maps
        Returns:
        the string representation of the data