Package adalid.core

Class AbstractArtifact

java.lang.Object
adalid.core.AbstractArtifact
All Implemented Interfaces:
Wrappable, Artifact
Direct Known Subclasses:
AbstractDataArtifact, AbstractExpression, Display, DisplayField, DisplaySet, EntityCollection, EntityCollectionAggregate, Instance, InstanceField, Key, KeyField, Operation, Project, Report, ReportField, ReportGroup, Step, StepField, Tab, TabField, Transition, Trigger, UIComponent, UserFlow, View, ViewField
public abstract class AbstractArtifact extends Object implements Artifact, Wrappable
Author:
Jorge Campins

  • Field Details

  • Constructor Details

    • AbstractArtifact

      public AbstractArtifact()

  • Method Details

    • isDeclared

      public boolean isDeclared()
      Specified by:
      isDeclared in interface Artifact
      Returns:
      true if the artifact is declared

    • isNotDeclared

      public boolean isNotDeclared()
      Specified by:
      isNotDeclared in interface Artifact
      Returns:
      true if the artifact is not declared

    • isFinalised

      public boolean isFinalised()
      Specified by:
      isFinalised in interface Artifact
      Returns:
      true if this artifact is already finalised; otherwise false

    • finalise

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

    • isFinished

      public boolean isFinished()
      Specified by:
      isFinished in interface Artifact
      Returns:
      the finished indicator

    • finish

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

    • checkName

      protected boolean checkName()

    • isInherited

      public boolean isInherited()
      Specified by:
      isInherited in interface Artifact
      Returns:
      true if the artifact is inherited

    • isNotInherited

      public boolean isNotInherited()
      Specified by:
      isNotInherited in interface Artifact
      Returns:
      true if the artifact is not inherited

    • isInheritedFromAbstract

      public boolean isInheritedFromAbstract()
      Specified by:
      isInheritedFromAbstract in interface Artifact
      Returns:
      true if the artifact is inherited from an abstract class

    • isNotInheritedFromAbstract

      public boolean isNotInheritedFromAbstract()
      Specified by:
      isNotInheritedFromAbstract in interface Artifact
      Returns:
      true if the artifact is not inherited from an abstract class

    • isInheritedFromConcrete

      public boolean isInheritedFromConcrete()
      Specified by:
      isInheritedFromConcrete in interface Artifact
      Returns:
      true if the artifact is inherited from a concrete class

    • isNotInheritedFromConcrete

      public boolean isNotInheritedFromConcrete()
      Specified by:
      isNotInheritedFromConcrete in interface Artifact
      Returns:
      true if the artifact is not inherited from a concrete class

    • getName

      public String getName()
      Specified by:
      getName in interface Artifact
      Returns:
      the name

    • getAlias

      public String getAlias()
      Specified by:
      getAlias in interface Artifact
      Returns:
      the alias

    • setAlias

      public 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.
      Specified by:
      setAlias in interface Artifact
      Parameters:
      alias - código alterno del proyecto

    • getTrace

      public String getTrace()
      Returns:
      the trace message

    • setTrace

      public void setTrace(String trace)
      Parameters:
      trace - message

    • getSqlName

      public String getSqlName()
      Specified by:
      getSqlName in interface Artifact
      Returns:
      the SQL name

    • setSqlName

      public 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.
      Specified by:
      setSqlName in interface Artifact
      Parameters:
      sqlName - nombre SQL del artefacto

    • getDefaultLocale

      public Locale getDefaultLocale()
      Specified by:
      getDefaultLocale in interface Artifact
      Returns:
      the default locale

    • getInlineHelpType

      public InlineHelpType getInlineHelpType()

    • setInlineHelpType

      public void setInlineHelpType(InlineHelpType type)

    • getDefaultLabel

      public String getDefaultLabel()
      Specified by:
      getDefaultLabel in interface Artifact
      Returns:
      the default label

    • setDefaultLabel

      public 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.
      Specified by:
      setDefaultLabel in interface Artifact
      Parameters:
      defaultLabel - sustantivo singular que se usa como etiqueta del artefacto

    • getDefaultShortLabel

      public String getDefaultShortLabel()
      Specified by:
      getDefaultShortLabel in interface Artifact
      Returns:
      the default short label

    • setDefaultShortLabel

      public 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.
      Specified by:
      setDefaultShortLabel in interface Artifact
      Parameters:
      defaultShortLabel - sustantivo singular, preferiblemente sin complementos, que se usa como etiqueta corta del artefacto

    • setDefaultShortLabel

      public 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.
      Specified by:
      setDefaultShortLabel in interface Artifact
      Parameters:
      defaultShortLabel - sustantivo singular, preferiblemente sin complementos, que se usa como etiqueta corta del artefacto

    • getDefaultColumnHeader

      public String getDefaultColumnHeader()
      Specified by:
      getDefaultColumnHeader in interface Artifact
      Returns:
      the default column header

    • setDefaultColumnHeader

      public void setDefaultColumnHeader(String defaultColumnHeader)
      El método setDefaultColumnHeader se utiliza para establecer el encabezado de columna 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 encabezado.
      Specified by:
      setDefaultColumnHeader in interface Artifact
      Parameters:
      defaultColumnHeader - sustantivo singular, preferiblemente sin complementos, que se usa como encabezado de columna del artefacto

    • setDefaultColumnHeader

      public void setDefaultColumnHeader(String... defaultColumnHeader)
      El método setDefaultColumnHeader se utiliza para establecer el encabezado de columna 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 encabezado.
      Specified by:
      setDefaultColumnHeader in interface Artifact
      Parameters:
      defaultColumnHeader - sustantivo singular, preferiblemente sin complementos, que se usa como encabezado de columna del artefacto

    • getDefaultCollectionLabel

      public String getDefaultCollectionLabel()
      Specified by:
      getDefaultCollectionLabel in interface Artifact
      Returns:
      the default collection label

    • setDefaultCollectionLabel

      public 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.
      Specified by:
      setDefaultCollectionLabel in interface Artifact
      Parameters:
      defaultCollectionLabel - sustantivo plural que se usa como etiqueta de colección del artefacto

    • getDefaultCollectionShortLabel

      public String getDefaultCollectionShortLabel()
      Specified by:
      getDefaultCollectionShortLabel in interface Artifact
      Returns:
      the default collection short label

    • setDefaultCollectionShortLabel

      public 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.
      Specified by:
      setDefaultCollectionShortLabel in interface Artifact
      Parameters:
      defaultCollectionShortLabel - sustantivo plural, preferiblemente sin complementos, que se usa como etiqueta corta de colección del artefacto

    • getDefaultDescription

      public String getDefaultDescription()
      Specified by:
      getDefaultDescription in interface Artifact
      Returns:
      the default description

    • setDefaultDescription

      public 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.
      Specified by:
      setDefaultDescription in interface Artifact
      Parameters:
      defaultDescription - una o más oraciones que describen el artefacto

    • getDefaultShortDescription

      public String getDefaultShortDescription()
      Specified by:
      getDefaultShortDescription in interface Artifact
      Returns:
      the default short description

    • setDefaultShortDescription

      public 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.
      Specified by:
      setDefaultShortDescription in interface Artifact
      Parameters:
      defaultShortDescription - una o más oraciones que describen brevemente el artefacto

    • getDefaultTooltip

      public String getDefaultTooltip()
      Specified by:
      getDefaultTooltip in interface Artifact
      Returns:
      the default tooltip

    • setDefaultTooltip

      public 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.
      Specified by:
      setDefaultTooltip in interface Artifact
      Parameters:
      defaultTooltip - una o más oraciones que describen muy brevemente el artefacto

    • getDefaultSymbol

      public String getDefaultSymbol()
      Specified by:
      getDefaultSymbol in interface Artifact
      Returns:
      the default symbol

    • setDefaultSymbol

      public 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.
      Specified by:
      setDefaultSymbol in interface Artifact
      Parameters:
      defaultSymbol - una o más oraciones que describen muy brevemente el artefacto

    • copyLocalizedStrings

      protected void copyLocalizedStrings(Artifact artifact)

    • getLocalizedLabel

      public String getLocalizedLabel(Locale locale)
      Specified by:
      getLocalizedLabel in interface Artifact
      Parameters:
      locale - the locale for the label
      Returns:
      the localized label

    • setLocalizedLabel

      public 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.
      Specified by:
      setLocalizedLabel in interface Artifact
      Parameters:
      locale - configuración regional
      localizedLabel - sustantivo singular que se usa como etiqueta del artefacto

    • getLocalizedShortLabel

      public String getLocalizedShortLabel(Locale locale)
      Specified by:
      getLocalizedShortLabel in interface Artifact
      Parameters:
      locale - the locale for the short label
      Returns:
      the localized short label

    • setLocalizedShortLabel

      public 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.
      Specified by:
      setLocalizedShortLabel in interface Artifact
      Parameters:
      locale - configuración regional
      localizedShortLabel - sustantivo singular, preferiblemente sin complementos, que se usa como etiqueta corta del artefacto

    • setLocalizedShortLabel

      public 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.
      Specified by:
      setLocalizedShortLabel in interface Artifact
      Parameters:
      locale - configuración regional
      localizedShortLabel - sustantivo singular, preferiblemente sin complementos, que se usa como etiqueta corta del artefacto

    • getLocalizedColumnHeader

      public String getLocalizedColumnHeader(Locale locale)
      Specified by:
      getLocalizedColumnHeader in interface Artifact
      Parameters:
      locale - the locale for the short label
      Returns:
      the localized column header

    • setLocalizedColumnHeader

      public void setLocalizedColumnHeader(Locale locale, String localizedColumnHeader)
      El método setLocalizedColumnHeader se utiliza para establecer el encabezado de columna 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 encabezado.
      Specified by:
      setLocalizedColumnHeader in interface Artifact
      Parameters:
      locale - configuración regional
      localizedColumnHeader - sustantivo singular, preferiblemente sin complementos, que se usa como encabezado de columna del artefacto

    • setLocalizedColumnHeader

      public void setLocalizedColumnHeader(Locale locale, String... localizedColumnHeader)
      El método setLocalizedColumnHeader se utiliza para establecer el encabezado de columna 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 encabezado.
      Specified by:
      setLocalizedColumnHeader in interface Artifact
      Parameters:
      locale - configuración regional
      localizedColumnHeader - sustantivo singular, preferiblemente sin complementos, que se usa como encabezado de columna del artefacto

    • getLocalizedCollectionLabel

      public String getLocalizedCollectionLabel(Locale locale)
      Specified by:
      getLocalizedCollectionLabel in interface Artifact
      Parameters:
      locale - the locale for the collection label
      Returns:
      the localized collection label

    • setLocalizedCollectionLabel

      public 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.
      Specified by:
      setLocalizedCollectionLabel in interface Artifact
      Parameters:
      locale - configuración regional
      localizedCollectionLabel - sustantivo plural que se usa como etiqueta de colección del artefacto

    • getLocalizedCollectionShortLabel

      public String getLocalizedCollectionShortLabel(Locale locale)
      Specified by:
      getLocalizedCollectionShortLabel in interface Artifact
      Parameters:
      locale - the locale for the collection short label
      Returns:
      the localized collection short label

    • setLocalizedCollectionShortLabel

      public 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.
      Specified by:
      setLocalizedCollectionShortLabel in interface Artifact
      Parameters:
      locale - configuración regional
      localizedCollectionShortLabel - sustantivo plural, preferiblemente sin complementos, que se usa como etiqueta corta de colección del artefacto

    • getLocalizedDescription

      public String getLocalizedDescription(Locale locale)
      Specified by:
      getLocalizedDescription in interface Artifact
      Parameters:
      locale - the locale for the description
      Returns:
      the localized description

    • setLocalizedDescription

      public 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.
      Specified by:
      setLocalizedDescription in interface Artifact
      Parameters:
      locale - configuración regional
      localizedDescription - una o más oraciones que describen el artefacto

    • getLocalizedShortDescription

      public String getLocalizedShortDescription(Locale locale)
      Specified by:
      getLocalizedShortDescription in interface Artifact
      Parameters:
      locale - the locale for the short description
      Returns:
      the localized short description

    • setLocalizedShortDescription

      public 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.
      Specified by:
      setLocalizedShortDescription in interface Artifact
      Parameters:
      locale - configuración regional
      localizedShortDescription - una o más oraciones que describen brevemente el artefacto

    • getLocalizedTooltip

      public String getLocalizedTooltip(Locale locale)
      Specified by:
      getLocalizedTooltip in interface Artifact
      Parameters:
      locale - the locale for the tooltip
      Returns:
      the localized tooltip

    • setLocalizedTooltip

      public 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.
      Specified by:
      setLocalizedTooltip in interface Artifact
      Parameters:
      locale - configuración regional
      localizedTooltip - una o más oraciones que describen muy brevemente el artefacto

    • getLocalizedSymbol

      public String getLocalizedSymbol(Locale locale)
      Specified by:
      getLocalizedSymbol in interface Artifact
      Parameters:
      locale - the locale for the symbol
      Returns:
      the localized symbol

    • setLocalizedSymbol

      public 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.
      Specified by:
      setLocalizedSymbol in interface Artifact
      Parameters:
      locale - configuración regional
      localizedSymbol - una o más oraciones que describen muy brevemente el artefacto

    • isLocalizedSymbolDefined

      public boolean isLocalizedSymbolDefined()

    • localeReadingKey

      protected Locale localeReadingKey(Locale locale)

    • localeWritingKey

      protected Locale localeWritingKey(Locale locale)

    • settler

      protected char settler()

    • getDeclaringArtifact

      public Artifact getDeclaringArtifact()
      Specified by:
      getDeclaringArtifact in interface Artifact
      Returns:
      the declaring artifact

    • getDeclaringField

      public Field getDeclaringField()
      Specified by:
      getDeclaringField in interface Artifact
      Returns:
      the declaring field

    • getDeclaringFieldNamedClassSimpleName

      public String getDeclaringFieldNamedClassSimpleName()

    • getDeclaringFieldIndex

      public int getDeclaringFieldIndex()
      Specified by:
      getDeclaringFieldIndex in interface Artifact
      Returns:
      the declaring field index

    • getDeclaringEntity

      public Entity getDeclaringEntity()
      Specified by:
      getDeclaringEntity in interface Artifact
      Returns:
      the declaring entity if the artifact directly declared by one, null otherwise

    • getDeclaringPersistentEntity

      public PersistentEntity getDeclaringPersistentEntity()
      Specified by:
      getDeclaringPersistentEntity in interface Artifact
      Returns:
      the declaring entity if the artifact directly declared by one, null otherwise

    • getDeclaringEntityRoot

      public Entity getDeclaringEntityRoot()
      Specified by:
      getDeclaringEntityRoot in interface Artifact
      Returns:
      the declaring entity if the artifact directly declared by one, null otherwise

    • getDeclaringPersistentEntityRoot

      public PersistentEntity getDeclaringPersistentEntityRoot()
      Specified by:
      getDeclaringPersistentEntityRoot in interface Artifact
      Returns:
      the declaring entity if the artifact directly declared by one, null otherwise

    • getDeclaringFieldEntityRoot

      public Entity getDeclaringFieldEntityRoot()
      Specified by:
      getDeclaringFieldEntityRoot in interface Artifact
      Returns:
      the declaring entity if the artifact directly declared by one, null otherwise

    • getDeclaringFieldPersistentEntityRoot

      public PersistentEntity getDeclaringFieldPersistentEntityRoot()
      Specified by:
      getDeclaringFieldPersistentEntityRoot in interface Artifact
      Returns:
      the declaring entity if the artifact directly declared by one, null otherwise

    • getDeclaringFieldPersistentEntityTableRoot

      public PersistentEntity getDeclaringFieldPersistentEntityTableRoot()
      Specified by:
      getDeclaringFieldPersistentEntityTableRoot in interface Artifact
      Returns:
      the declaring entity if the artifact directly declared by one, null otherwise

    • getDeclaringOperation

      public Operation getDeclaringOperation()
      Specified by:
      getDeclaringOperation in interface Artifact
      Returns:
      the declaring operation if the artifact directly declared by one, null otherwise

    • depth

      public int depth()
      Specified by:
      depth in interface Artifact
      Returns:
      the depth

    • round

      public int round()
      Specified by:
      round in interface Artifact
      Returns:
      the round

    • clearAttributes

      public void clearAttributes()
      Specified by:
      clearAttributes in interface Artifact

    • addAttributes

      public void addAttributes()
      Specified by:
      addAttributes in interface Artifact

    • getAttributes

      public Map<String,Object> getAttributes()
      Returns:
      the attributes map

    • getAttributesKeySetByRegex

      public Set<String> getAttributesKeySetByRegex(String regex)

    • isAnnotated

      public boolean isAnnotated()
      Specified by:
      isAnnotated in interface Artifact
      Returns:
      true if the artifact is annotated

    • annotate

      public void annotate()

    • isValidTypeAnnotation

      protected boolean isValidTypeAnnotation(Class<? extends Annotation> annotation)

    • getValidTypeAnnotations

      protected List<Class<? extends Annotation>> getValidTypeAnnotations()

    • isValidFieldAnnotation

      protected boolean isValidFieldAnnotation(Class<? extends Annotation> annotation)

    • getValidFieldAnnotations

      protected List<Class<? extends Annotation>> getValidFieldAnnotations()

    • put

      public Field put(Class<? extends Annotation> annotation, Field field)
      Specified by:
      put in interface Artifact
      Parameters:
      annotation - annotation
      field - field
      Returns:
      field

    • setStaticAttributes

      protected void setStaticAttributes()

    • copyBootstrappingAttributes

      protected void copyBootstrappingAttributes()

    • defaultLocale

      protected Locale defaultLocale()

    • addAttribute

      public Object addAttribute(Class<?> clazz, String name, KVP value)
      El método addAttribute permite agregar un atributo a la lista de atributos extraordinarios del artefacto. Los atributos extraordinarios son parejas clave/valor, de modo que si se agregan varios atributos con la misma clave a un artefacto, el valor de tal atributo será el último valor agregado.
      Specified by:
      addAttribute in interface Artifact
      Parameters:
      clazz - clase a la que corresponde el atributo
      name - clave del atributo
      value - valor del atributo
      Returns:
      el valor anterior asociado con la clave, o nulo si no había una asignación para la clave, o si la implementación admite valores nulos.

    • addAttribute

      public Object addAttribute(String name, KVP value)
      El método addAttribute permite agregar un atributo a la lista de atributos extraordinarios del artefacto. Los atributos extraordinarios son parejas clave/valor, de modo que si se agregan varios atributos con la misma clave a un artefacto, el valor de tal atributo será el último valor agregado.
      Specified by:
      addAttribute in interface Artifact
      Parameters:
      name - clave del atributo
      value - valor del atributo
      Returns:
      el valor anterior asociado con la clave, o nulo si no había una asignación para la clave, o si la implementación admite valores nulos.

    • addAttribute

      public Object addAttribute(Class<?> clazz, String name, KVP... value)
      El método addAttribute permite agregar un atributo a la lista de atributos extraordinarios del artefacto. Los atributos extraordinarios son parejas clave/valor, de modo que si se agregan varios atributos con la misma clave a un artefacto, el valor de tal atributo será el último valor agregado.
      Specified by:
      addAttribute in interface Artifact
      Parameters:
      clazz - clase a la que corresponde el atributo
      name - clave del atributo
      value - valor del atributo
      Returns:
      el valor anterior asociado con la clave, o nulo si no había una asignación para la clave, o si la implementación admite valores nulos.

    • addAttribute

      public Object addAttribute(String name, KVP... value)
      El método addAttribute permite agregar un atributo a la lista de atributos extraordinarios del artefacto. Los atributos extraordinarios son parejas clave/valor, de modo que si se agregan varios atributos con la misma clave a un artefacto, el valor de tal atributo será el último valor agregado.
      Specified by:
      addAttribute in interface Artifact
      Parameters:
      name - clave del atributo
      value - valor del atributo
      Returns:
      el valor anterior asociado con la clave, o nulo si no había una asignación para la clave, o si la implementación admite valores nulos.

    • addAttribute

      public Object addAttribute(Class<?> clazz, String name, Object value)
      El método addAttribute permite agregar un atributo a la lista de atributos extraordinarios del artefacto. Los atributos extraordinarios son parejas clave/valor, de modo que si se agregan varios atributos con la misma clave a un artefacto, el valor de tal atributo será el último valor agregado.
      Specified by:
      addAttribute in interface Artifact
      Parameters:
      clazz - clase a la que corresponde el atributo
      name - clave del atributo
      value - valor del atributo
      Returns:
      el valor anterior asociado con la clave, o nulo si no había una asignación para la clave, o si la implementación admite valores nulos.

    • addAttribute

      public Object addAttribute(String name, Object value)
      El método addAttribute permite agregar un atributo a la lista de atributos extraordinarios del artefacto. Los atributos extraordinarios son parejas clave/valor, de modo que si se agregan varios atributos con la misma clave a un artefacto, el valor de tal atributo será el último valor agregado.
      Specified by:
      addAttribute in interface Artifact
      Parameters:
      name - clave del atributo
      value - valor del atributo
      Returns:
      el valor anterior asociado con la clave, o nulo si no había una asignación para la clave, o si la implementación admite valores nulos.

    • addAttribute

      public Object addAttribute(Class<?> clazz, String name, Object... value)
      El método addAttribute permite agregar un atributo a la lista de atributos extraordinarios del artefacto. Los atributos extraordinarios son parejas clave/valor, de modo que si se agregan varios atributos con la misma clave a un artefacto, el valor de tal atributo será el último valor agregado.
      Specified by:
      addAttribute in interface Artifact
      Parameters:
      clazz - clase a la que corresponde el atributo
      name - clave del atributo
      value - valor del atributo
      Returns:
      el valor anterior asociado con la clave, o nulo si no había una asignación para la clave, o si la implementación admite valores nulos.

    • addAttribute

      public Object addAttribute(String name, Object... value)
      El método addAttribute permite agregar un atributo a la lista de atributos extraordinarios del artefacto. Los atributos extraordinarios son parejas clave/valor, de modo que si se agregan varios atributos con la misma clave a un artefacto, el valor de tal atributo será el último valor agregado.
      Specified by:
      addAttribute in interface Artifact
      Parameters:
      name - clave del atributo
      value - valor del atributo
      Returns:
      el valor anterior asociado con la clave, o nulo si no había una asignación para la clave, o si la implementación admite valores nulos.

    • getAttribute

      public Object getAttribute(Class<?> clazz, String name)
      Specified by:
      getAttribute in interface Artifact
      Parameters:
      clazz - class
      name - name
      Returns:
      object

    • getAttribute

      public Object getAttribute(String name)
      Specified by:
      getAttribute in interface Artifact
      Parameters:
      name - name
      Returns:
      object

    • getBooleanAttribute

      public Boolean getBooleanAttribute(Class<?> clazz, String name)

    • getBooleanAttribute

      public Boolean getBooleanAttribute(String name)

    • getIntegerAttribute

      public Integer getIntegerAttribute(Class<?> clazz, String name)

    • getIntegerAttribute

      public Integer getIntegerAttribute(String name)

    • getIntegerAttribute

      public Integer getIntegerAttribute(Class<?> clazz, String name, Integer min, Integer max)

    • getIntegerAttribute

      public Integer getIntegerAttribute(String name, Integer min, Integer max)

    • getStringAttribute

      public String getStringAttribute(Class<?> clazz, String name)

    • getStringAttribute

      public String getStringAttribute(String name)

    • getStringAttribute

      public String getStringAttribute(Class<?> clazz, String name, String equals, String separator, String open, String close)

    • getStringAttribute

      public String getStringAttribute(String name, String equals, String separator, String open, String close)

    • getStringKeyValuePairAttribute

      public String getStringKeyValuePairAttribute(Class<?> clazz, String name, String key)

    • getStringKeyValuePairAttribute

      public String getStringKeyValuePairAttribute(Class<?> clazz, String name, String key, Object defaultValue)

    • getKeyValuePairAttribute

      public Object getKeyValuePairAttribute(Class<?> clazz, String name, String key)

    • getKeyValuePairAttribute

      public Object getKeyValuePairAttribute(String name, String key)

    • getKeyValuePairAttribute

      public Object getKeyValuePairAttribute(Class<?> clazz, String name, String key, Object defaultValue)

    • getKeyValuePairAttribute

      public Object getKeyValuePairAttribute(String name, String key, Object defaultValue)

    • getAttributesArray

      public Object getAttributesArray(Class<?> clazz, String name)

    • getAttributesArray

      public Object getAttributesArray(String name)

    • getClassPath

      public String getClassPath()
      Specified by:
      getClassPath in interface Artifact
      Returns:
      the class path

    • isClassInPath

      public boolean isClassInPath(Class<?> type)
      Specified by:
      isClassInPath in interface Artifact
      Parameters:
      type - class to test
      Returns:
      true if type is present in the class path

    • getPathList

      public List<Artifact> getPathList()
      Specified by:
      getPathList in interface Artifact
      Returns:
      the path

    • getPathString

      public String getPathString()
      Specified by:
      getPathString in interface Artifact
      Returns:
      the path string

    • getFullName

      public String getFullName()
      Specified by:
      getFullName in interface Artifact
      Returns:
      the full name

    • getPartialName

      public String getPartialName()
      Specified by:
      getPartialName in interface Artifact
      Returns:
      the partial name

    • getPartialSqlName

      public String getPartialSqlName()

    • getCrypticName

      public String getCrypticName(String prefix, String suffix)
      Specified by:
      getCrypticName in interface Artifact
      Parameters:
      prefix - prefijo
      suffix - sufijo
      Returns:
      the cryptic name

    • getKeyFeatures

      public String getKeyFeatures(String prefix, String suffix)
      Specified by:
      getKeyFeatures in interface Artifact
      Parameters:
      prefix - prefijo
      suffix - sufijo
      Returns:
      the key features

    • getValueString

      protected String getValueString(Object value)

    • getValueString

      protected String getValueString(Object object, Object value)

    • isOperation

      public boolean isOperation()
      Specified by:
      isOperation in interface Artifact
      Returns:
      true if this artifact is an Operation; otherwise false

    • isExpression

      public boolean isExpression()
      Specified by:
      isExpression in interface Artifact
      Returns:
      true if this artifact is an Expression; otherwise false

    • fa

      protected String fa(String name)

    • isFontAwesomeClass

      protected boolean isFontAwesomeClass(String name)

    • xs

      protected String xs(String name)

    • isUnicodeSymbolClass

      protected boolean isUnicodeSymbolClass(String name)

    • isValidEmbeddedDocument

      protected boolean isValidEmbeddedDocument(String document)

    • isValidHelpFileName

      protected boolean isValidHelpFileName(String fileName)

    • isValidHelpFileType

      protected boolean isValidHelpFileType(String fileName)

    • isValidSnippetFileName

      protected boolean isValidSnippetFileName(String fileName)

    • isValidJavaClassName

      protected boolean isValidJavaClassName(String className)

    • verifyExpression

      protected boolean verifyExpression(Expression expression)

    • verifyExpression

      protected boolean verifyExpression(Expression expression, Artifact artifact)

    • verifyExpression

      protected boolean verifyExpression(Expression expression, ExpressionUsage usage)

    • verifyExpression

      protected boolean verifyExpression(Expression expression, Artifact artifact, ExpressionUsage usage)

    • verifyExpression

      protected boolean verifyExpression(Expression expression, Artifact artifact, boolean calculableless)

    • verifyExpression

      protected boolean verifyExpression(Expression expression, Artifact artifact, ExpressionUsage usage, boolean calculableless)

    • verifyNames

      protected void verifyNames(Class<?> top, Class<?> clazz)

    • coalesce

      protected <T> T coalesce(T... objects)

    • greaterThanZero

      protected int greaterThanZero(int... values)

    • specified

      protected <E extends Enum> E specified(E... enums)

    • specified

      protected <E extends Enum> E specified(String unspecified, E... values)

    • specified

      protected String specified(String... strings)

    • specified

      protected String[] specified(String[] strings, String[] defaultStrings)

    • specified

      protected <T> T[] specified(T[] values, T[] defaultValues)

    • specified

      protected int[] specified(int[] a1, int[] a2)

    • specified

      protected Integer specified(Integer... values)

    • specified

      protected Character specified(Character... values)

    • getWrapper

      public Wrapper getWrapper()
      Specified by:
      getWrapper in interface Wrappable
      Returns:
      the wrapper

    • getDefaultWrapperClass

      public Class<? extends ArtifactWrapper> getDefaultWrapperClass()
      Specified by:
      getDefaultWrapperClass in interface Wrappable
      Returns:
      the default wrapper class

    • checkScope

      protected void checkScope()

    • a

      protected String a(String href, String text)
      This method builds an HTML <a> pseudo-tag, which defines a hyperlink.
      Parameters:
      href - Specifies the URL of the page the link goes to
      text - string to display instead of the URL
      Returns:
      an HTML <a> pseudo-tag

    • b

      protected String b(String string)
      This method builds an HTML <b> pseudo-tag, which defines bold text without any extra importance.
      Parameters:
      string - text to display in bold
      Returns:
      an HTML <b> pseudo-tag

    • b

      protected String b(String separator, String... strings)
      This method builds several HTML <b> pseudo-tags, separated by separator.
      Parameters:
      separator - a text to separate the pseudo-tags
      strings - one or more texts to display in bold
      Returns:
      several HTML <b> pseudo-tags, separated by separator.

    • ic

      protected static String ic(String clazz)
      This method builds an HTML <i> pseudo-tag for a CSS class.
      Parameters:
      clazz - Specifies the CSS class
      Returns:
      an HTML <i> pseudo-tag

    • ic

      protected static String ic(String clazz, String text)
      This method builds an HTML <i> pseudo-tag, which defines text with a CSS class.
      Parameters:
      clazz - Specifies the CSS class
      text - string to display
      Returns:
      an HTML <i> pseudo-tag

    • i

      protected String i(String string)
      This method builds an HTML <i> pseudo-tag, which defines italic text.
      Parameters:
      string - text to display in italic
      Returns:
      an HTML <i> pseudo-tag

    • i

      protected String i(String separator, String... strings)
      This method builds several HTML <i> pseudo-tags, separated by separator.
      Parameters:
      separator - a text to separate the pseudo-tags
      strings - one or more texts to display in italic
      Returns:
      several HTML <i> pseudo-tags, separated by separator.

    • m

      protected String m(String string)
      This method builds an HTML <mark> pseudo-tag, which defines text that should be marked or highlighted.
      Parameters:
      string - text to be marked or highlighted
      Returns:
      an HTML <mark> pseudo-tag

    • m

      protected String m(String separator, String... strings)
      This method builds several HTML <mark> pseudo-tags, separated by separator.
      Parameters:
      separator - a text to separate the pseudo-tags
      strings - one or more texts to be marked or highlighted
      Returns:
      several HTML <mark> pseudo-tags, separated by separator.

    • s

      protected String s(String string)
      This method builds an HTML <del> pseudo-tag, which defines text that should be struck out.
      Parameters:
      string - text to be struck out
      Returns:
      an HTML <del> pseudo-tag

    • s

      protected String s(String separator, String... strings)
      This method builds several HTML <del> pseudo-tags, separated by separator.
      Parameters:
      separator - a text to separate the pseudo-tags
      strings - one or more texts to be struck out
      Returns:
      several HTML <del> pseudo-tags, separated by separator.

    • u

      protected String u(String string)
      This method builds an HTML <ins> pseudo-tag, which defines text that should be underlined.
      Parameters:
      string - text to be underlined
      Returns:
      an HTML <ins> pseudo-tag

    • u

      protected String u(String separator, String... strings)
      This method builds several HTML <ins> pseudo-tags, separated by separator.
      Parameters:
      separator - a text to separate the pseudo-tags
      strings - one or more texts to be underlined
      Returns:
      several HTML <ins> pseudo-tags, separated by separator.

    • ul

      protected String ul(String... strings)
      This method builds an HTML <ul> pseudo-tag, which defines an unordered (bulleted) list.
      Parameters:
      strings - one or more texts defining the list items
      Returns:
      an HTML <ul> pseudo-tag

    • h1

      protected static String h1(String string)
      This method builds an HTML <h1> pseudo-tag, which defines a level 1 heading.
      Parameters:
      string - header text
      Returns:
      an HTML <h1> pseudo-tag

    • h2

      protected static String h2(String string)
      This method builds an HTML <h2> pseudo-tag, which defines a level 2 heading.
      Parameters:
      string - header text
      Returns:
      an HTML <h2> pseudo-tag

    • h3

      protected static String h3(String string)
      This method builds an HTML <h3> pseudo-tag, which defines a level 3 heading.
      Parameters:
      string - header text
      Returns:
      an HTML <h3> pseudo-tag

    • h4

      protected static String h4(String string)
      This method builds an HTML <h4> pseudo-tag, which defines a level 4 heading.
      Parameters:
      string - header text
      Returns:
      an HTML <h4> pseudo-tag

    • h5

      protected static String h5(String string)
      This method builds an HTML <h5> pseudo-tag, which defines a level 5 heading.
      Parameters:
      string - header text
      Returns:
      an HTML <h5> pseudo-tag

    • h6

      protected static String h6(String string)
      This method builds an HTML <h6> pseudo-tag, which defines a level 6 heading.
      Parameters:
      string - header text
      Returns:
      an HTML <h6> pseudo-tag

    • bigDecimal

      protected static BigDecimal bigDecimal(String value)

    • bigDecimal

      protected static BigDecimal bigDecimal(int value)

    • bigDecimal

      protected static BigDecimal bigDecimal(long value)

    • bigDecimal

      protected static BigDecimal bigDecimal(float value)

    • bigDecimal

      protected static BigDecimal bigDecimal(double value)

    • bigInteger

      protected static BigInteger bigInteger(String value)

    • bigInteger

      protected static BigInteger bigInteger(int value)

    • bigInteger

      protected static BigInteger bigInteger(long value)

    • bigInteger

      protected static BigInteger bigInteger(float value)

    • bigInteger

      protected static BigInteger bigInteger(double value)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • toString

      protected String toString(String simpleName)

    • hashCodeHexString

      public String hashCodeHexString()
      Specified by:
      hashCodeHexString in interface Artifact
      Returns:
      the hex string representation of the hash code

    • toString

      public String toString(int n)
      Specified by:
      toString in interface Artifact
      Parameters:
      n - n
      Returns:
      the string representation of the data

    • toString

      public String toString(int n, String key)
      Specified by:
      toString in interface Artifact
      Parameters:
      n - n
      key - key
      Returns:
      the string representation of the data

    • toString

      public String toString(int n, String key, boolean verbose)
      Specified by:
      toString in interface Artifact
      Parameters:
      n - n
      key - key
      verbose - verbose
      Returns:
      the string representation of the data

    • toString

      public String toString(int n, String key, boolean verbose, boolean fields, boolean maps)
      Specified by:
      toString in interface Artifact
      Parameters:
      n - n
      key - key
      verbose - verbose
      fields - fields
      maps - maps
      Returns:
      the string representation of the data

    • classToString

      protected String classToString(int n, String key, boolean verbose)

    • fieldsToString

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

    • mapsToString

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