Package adalid.core.data.types

Class StringData

java.lang.Object
adalid.core.AbstractArtifact
adalid.core.AbstractDataArtifact
adalid.core.Primitive
adalid.core.primitives.CharacterPrimitive
adalid.core.data.types.StringData
All Implemented Interfaces:
Wrappable, AnnotatableArtifact, Artifact, CalculableProperty, CharacterExpression, DataArtifact, Expression, Nullable, Parameter, Property, TypedArtifact, ValuedArtifact, Serializable
Direct Known Subclasses:
StringParameter, StringProperty
public class StringData extends CharacterPrimitive
Author:
Jorge Campins
See Also:

  • Field Details

  • Constructor Details

    • StringData

      public StringData()

  • Method Details

    • getDataGenFunction

      public String getDataGenFunction()
      Overrides:
      getDataGenFunction in class AbstractDataArtifact
      Returns:
      the data generation user-defined function name

    • isSearchField

      public boolean isSearchField()
      Specified by:
      isSearchField in interface Property
      Overrides:
      isSearchField in class AbstractDataArtifact
      Returns:
      the search field indicator

    • isFilterField

      public boolean isFilterField()
      Specified by:
      isFilterField in interface Property
      Overrides:
      isFilterField in class AbstractDataArtifact
      Returns:
      the filter field indicator

    • isSortField

      public boolean isSortField()
      Specified by:
      isSortField in interface Property
      Overrides:
      isSortField in class AbstractDataArtifact
      Returns:
      the sort field indicator

    • isReportField

      public boolean isReportField()
      Specified by:
      isReportField in interface Property
      Overrides:
      isReportField in class AbstractDataArtifact
      Returns:
      the report field indicator

    • isExportField

      public boolean isExportField()
      Specified by:
      isExportField in interface Property
      Overrides:
      isExportField in class AbstractDataArtifact
      Returns:
      the export field indicator

    • isLoremIpsum

      public Boolean isLoremIpsum()
      Overrides:
      isLoremIpsum in class AbstractDataArtifact
      Returns:
      the character Lorem Ipsum indicator

    • isResizableString

      public boolean isResizableString()

    • getMinLength

      public int getMinLength()
      Returns:
      the minLength

    • setMinLength

      public void setMinLength(int minLength)
      Sets the string minimum length. WARNING: max length should be set BEFORE min length.
      Parameters:
      minLength - the minLength to set

    • getMaxLength

      public Integer getMaxLength()
      Returns:
      the maxLength

    • setMaxLength

      public void setMaxLength(Integer maxLength)
      Sets the string maximum length. WARNING: max length should be set BEFORE min length.
      Parameters:
      maxLength - the maxLength to set

    • isLargeObject

      public boolean isLargeObject()

    • getFetchType

      public FetchType getFetchType()

    • setFetchType

      public void setFetchType(FetchType fetchType)
      El método setFetchType se utiliza para establecer la estrategia para obtener datos de la base de datos. Este método solo aplica si la meta propiedad tiene longitud ilimitada, es decir, su maxLength es 0. Con la estrategia EAGER, el valor de la propiedad se obtiene simultáneamente con el resto de las propiedades de la entidad. Con la estrategia LAZY, el valor se obtiene posteriormente, por demanda, cuando se accede a la propiedad por primera vez. El valor predeterminado del atributo es EAGER.
      Parameters:
      fetchType - especifica si la operación de consulta obtiene el valor de la propiedad simultáneamente con el resto de las propiedades de la entidad o posteriormente, por demanda. Su valor es uno de los elementos de la enumeración FetchType. Seleccione EAGER para obtener el valor de la propiedad simultáneamente con el resto de las propiedades de la entidad; seleccione LAZY para obtenerlo posteriormente, por demanda; alternativamente, omita el elemento o seleccione UNSPECIFIED para utilizar el valor predeterminado del atributo. El valor predeterminado del atributo es EAGER.

    • getDisplayLength

      public Integer getDisplayLength()
      Returns:
      the displayLength

    • getMaxDisplayLength

      public Integer getMaxDisplayLength()
      Returns:
      the displayLength

    • setDisplayLength

      public void setDisplayLength(Integer displayLength)
      Sets the string display length.
      Parameters:
      displayLength - the displayLength to set

    • getInputMask

      public String getInputMask()
      Returns:
      the input mask

    • setInputMask

      public void setInputMask(String inputMask)
      Parameters:
      inputMask - the input mask to set

    • getSlotChar

      public char getSlotChar()
      Returns:
      the slot char

    • setSlotChar

      public void setSlotChar(char slotChar)
      Parameters:
      slotChar - the slot char to set

    • getPattern

      public Pattern getPattern()
      Returns:
      the pattern

    • setPattern

      public void setPattern(Pattern pattern)
      Parameters:
      pattern - the pattern to set

    • getPatternRegex

      public String getPatternRegex()

    • getDefaultRegexErrorMessage

      public String getDefaultRegexErrorMessage()
      Returns:
      the default regex error message

    • setDefaultRegexErrorMessage

      public void setDefaultRegexErrorMessage(String message)
      El método setDefaultRegexErrorMessage se utiliza para establecer el mensaje de error asociado a la expresión regular definida mediante el elemento regex de la anotación StringField, 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 mensaje.
      Parameters:
      message - mensaje de error asociado a la expresión regular

    • getLocalizedRegexErrorMessage

      public String getLocalizedRegexErrorMessage(Locale locale)
      Parameters:
      locale - the locale for the regex error message
      Returns:
      the localized regex error message

    • setLocalizedRegexErrorMessage

      public void setLocalizedRegexErrorMessage(Locale locale, String message)
      El método setLocalizedRegexErrorMessage se utiliza para establecer el mensaje de error asociado a la expresión regular definida mediante el elemento regex de la anotación StringField, 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 mensaje.
      Parameters:
      locale - configuración regional
      message - mensaje de error asociado a la expresión regular

    • getAutoComplete

      public AutoComplete getAutoComplete()
      Returns:
      the auto complete

    • setAutoComplete

      public void setAutoComplete(AutoComplete autoComplete)
      Parameters:
      autoComplete - the auto complete to set

    • getLetterCase

      public LetterCase getLetterCase()
      Returns:
      the letter case

    • setLetterCase

      public void setLetterCase(LetterCase letterCase)
      Parameters:
      letterCase - the letter case to set

    • isAllowDiacritics

      public boolean isAllowDiacritics()
      Returns:
      the allow diacritics indicator

    • setAllowDiacritics

      public void setAllowDiacritics(boolean allowDiacritics)
      Parameters:
      allowDiacritics - the allow diacritics indicator to set

    • isRichTextFormat

      public boolean isRichTextFormat()
      Returns:
      the rich text format indicator

    • setRichTextFormat

      public void setRichTextFormat(boolean richTextFormat)
      Parameters:
      richTextFormat - the rich text format indicator to set

    • isTranslatable

      public boolean isTranslatable()
      Returns:
      the allow translatation indicator

    • isTranslationAllowed

      public boolean isTranslationAllowed()

    • setTranslatable

      public void setTranslatable(boolean translatable)
      Parameters:
      translatable - the allow translatation indicator to set

    • getSpecialConverterName

      public String getSpecialConverterName()
      Returns:
      the special converter name

    • setSpecialConverterName

      public void setSpecialConverterName(String converter)

    • getSpecialValidatorName

      public String getSpecialValidatorName()
      Returns:
      the special validator name

    • setSpecialValidatorName

      public void setSpecialValidatorName(String validator)

    • getTypeNameExpression

      public CharacterExpression getTypeNameExpression()
      Returns:
      the type name expression

    • setTypeNameExpression

      public void setTypeNameExpression(CharacterExpression expression)
      Parameters:
      expression - the type name expression to set

    • getUrlType

      public UrlType getUrlType()
      Returns:
      the url type

    • setUrlType

      public void setUrlType(UrlType type)
      Parameters:
      type - the url type to set

    • getUrlDisplayMode

      public DisplayMode getUrlDisplayMode()
      Returns:
      the url display mode

    • setUrlDisplayMode

      public void setUrlDisplayMode(DisplayMode mode)
      Parameters:
      mode - the url display mode to set

    • getUrlDisplayType

      public UrlDisplayType getUrlDisplayType()
      Returns:
      the url display type

    • setUrlDisplayType

      public void setUrlDisplayType(UrlDisplayType type)
      Parameters:
      type - the url display type to set

    • getSourceURLsJoint

      public String getSourceURLsJoint()

    • getSourceURLs

      public String[] getSourceURLs()
      Returns:
      the list of valid URLs

    • setSourceURLs

      public void setSourceURLs(String... urls)
      Parameters:
      urls - the list of valid URLs to set

    • getSearchURL

      public String getSearchURL()
      Returns:
      the URL of the website to search for the value

    • setSearchURL

      public void setSearchURL(String searchURL)
      Parameters:
      searchURL - the URL to set

    • isGoogleMapsEmbedInlineFrame

      public boolean isGoogleMapsEmbedInlineFrame()
      Returns:
      the inline frame indicator of embedded maps

    • isEncodingEnabled

      public boolean isEncodingEnabled()
      Returns:
      the encoding-enabled indicator

    • setEncodingEnabled

      public void setEncodingEnabled(boolean encoding)
      El método setEncodingEnabled se utiliza para habilitar la codificación del valor de la propiedad para almacenarlo en la base de datos.

      Advertencias

      • La codificación limita significativamente el uso de la propiedad en consultas e informes.
      • El algoritmo de codificación utilizado es Base64, el cual no es un algoritmo de cifrado, se decodifica fácilmente y, por lo tanto, no debe utilizarse como un método de cifrado seguro.
      • La longitud del valor codificado es un tercio mayor que la longitud del valor original; si, por ejemplo, la longitud máxima de la propiedad se establece en 2000, entonces la propiedad solo puede contener valores de hasta 1500 caracteres.
      Parameters:
      encoding - true para habilitar la codificación
      See Also:

    • getEncodingType

      public EncodingType getEncodingType()
      Returns:
      the encoding type

    • encodingType

      protected EncodingType encodingType()

    • setEncodingType

      public void setEncodingType(EncodingType encoding)
      El método setEncodingType se utiliza para establecer el tipo de codificación del valor de la propiedad para almacenarlo en la base de datos. El algoritmo de codificación utilizado es Base64. Su valor es uno de los elementos de la enumeración EncodingType.

      Seleccione:

      • BASIC, para utilizar el "Alfabeto Base64" como se especifica en la Tabla 1 de RFC 4648 y RFC 2045 para la operación de codificación y decodificación. El codificador no agrega ningún carácter de avance de línea (separador de línea). El decodificador rechaza los datos que contienen caracteres fuera del alfabeto base64.
      • FILENAME o URL, para utilizar el "Alfabeto Base64 seguro para URL y nombre de archivo" como se especifica en la Tabla 2 de RFC 4648 para la codificación y decodificación. El codificador no agrega ningún carácter de avance de línea (separador de línea). El decodificador rechaza los datos que contienen caracteres fuera del alfabeto base64.
      • MIME, para utilizar el "Alfabeto Base64" como se especifica en la Tabla 1 de RFC 2045 para la operación de codificación y decodificación. La salida codificada debe representarse en líneas de no más de 76 caracteres cada una y utiliza un retorno de carro '\r' seguido inmediatamente por un salto de línea '\n' como separador de línea. No se agrega ningún separador de línea al final de la salida codificada. Todos los separadores de línea u otros caracteres que no se encuentran en la tabla alfabética base64 se ignoran en la operación de decodificación.

      Alternativamente, seleccione UNSPECIFIED para utilizar el valor predeterminado. El valor predeteminado es:

      • BASIC, para propiedades que contienen una definición de documento incrustado (anotadas con @EmbeddedDocument)
      • FILENAME, para propiedades que contienen una referencias a un archivo cargado en el servidor (anotadas con @FileReference)
      • URL, para propiedades que contienen una URL (anotadas con @UniformResourceLocator o @UrlProperty)
      • UNSPECIFIED, para las demás propiedades
      Parameters:
      encoding - tipo de codificación
      See Also:

    • getFileDownloadStartFunction

      public String getFileDownloadStartFunction()

    • setFileDownloadStartFunction

      public void setFileDownloadStartFunction(String function)

    • getFileDownloadStopFunction

      public String getFileDownloadStopFunction()

    • setFileDownloadStopFunction

      public void setFileDownloadStopFunction(String function)

    • getFileViewerDialogReturnUpdate

      public String getFileViewerDialogReturnUpdate()

    • setFileViewerDialogReturnUpdate

      public void setFileViewerDialogReturnUpdate(String... update)

    • isFileUploadAutoStart

      public boolean isFileUploadAutoStart()
      Returns:
      the file-upload auto-start indicator

    • fileUploadAutoStart

      public Boolean fileUploadAutoStart()

    • setFileUploadAutoStart

      public void setFileUploadAutoStart(boolean autoStart)
      Parameters:
      autoStart - the file-upload auto-start indicator to set

    • isFileUploadVirusScan

      public boolean isFileUploadVirusScan()
      Returns:
      the file-upload virus-scan indicator

    • fileUploadVirusScan

      public Boolean fileUploadVirusScan()

    • setFileUploadVirusScan

      public void setFileUploadVirusScan(boolean virusScan)
      Parameters:
      virusScan - the file-upload virus-scan indicator to set

    • getFileUploadFileLimit

      public int getFileUploadFileLimit()
      Returns:
      the file-upload file limit

    • fileUploadFileLimit

      protected int fileUploadFileLimit()

    • setFileUploadFileLimit

      public void setFileUploadFileLimit(int fileLimit)
      Parameters:
      fileLimit - the file-upload file limit indicator to set

    • getFileUploadUndoLimit

      public int getFileUploadUndoLimit()
      Returns:
      the file-upload file limit

    • fileUploadUndoLimit

      protected int fileUploadUndoLimit()

    • setFileUploadUndoLimit

      public void setFileUploadUndoLimit(int undoLimit)
      Parameters:
      undoLimit - the file-upload retry limit indicator to set

    • getMaxInputFileSize

      public int getMaxInputFileSize()
      Returns:
      the max input file size

    • maxInputFileSize

      protected int maxInputFileSize()

    • setMaxInputFileSize

      public void setMaxInputFileSize(int size)
      Parameters:
      size - the max input file size to set

    • getValidInputFileTypes

      public MimeType[] getValidInputFileTypes()
      Returns:
      the valid input file types

    • setValidInputFileTypes

      public void setValidInputFileTypes(MimeType[] types)
      Parameters:
      types - the valid input file types to set

    • getValidInputFileTypesRegex

      public String getValidInputFileTypesRegex()
      Returns:
      the valid input file regex

    • getValidInputFilePattern

      public Pattern getValidInputFilePattern()
      Returns:
      the valid input file pattern

    • setValidInputFilePattern

      public void setValidInputFilePattern(Pattern pattern)
      Parameters:
      pattern - the valid input file pattern to set

    • getValidInputFilePatternRegex

      public String getValidInputFilePatternRegex()

    • getUploadStorageOption

      public UploadStorageOption getUploadStorageOption()
      Returns:
      the upload storage option

    • setUploadStorageOption

      public void setUploadStorageOption(UploadStorageOption option)
      Parameters:
      option - the upload storage option to set

    • getPathTemplate

      public String getPathTemplate()
      Returns:
      the path template

    • setPathTemplate

      public void setPathTemplate(String fieldName)
      Parameters:
      fieldName - the path template to set

    • getBlobFieldName

      public String getBlobFieldName()
      Returns:
      the blob field name

    • setBlobFieldName

      public void setBlobFieldName(String fieldName)
      Parameters:
      fieldName - the blob field name to set

    • getBlobField

      public Field getBlobField()
      Returns:
      the blob field

    • setBlobField

      public Field setBlobField(Field field)
      Parameters:
      field - the blob field to set
      Returns:
      the previously set blob field

    • setBlobEntity

      public void setBlobEntity(Entity entity)
      Parameters:
      entity - the blob entity to set

    • getBlobProperty

      public Property getBlobProperty()
      Returns:
      the blob property

    • setBlobProperty

      public void setBlobProperty(Property property)
      Parameters:
      property - the blob property to set

    • getJoinFieldName

      public String getJoinFieldName()
      Returns:
      the join field name

    • setJoinFieldName

      public void setJoinFieldName(String fieldName)
      Parameters:
      fieldName - the join field name to set

    • getJoinField

      public Field getJoinField()
      Returns:
      the join field

    • setJoinField

      public Field setJoinField(Field field)
      Parameters:
      field - the join field to set
      Returns:
      the previously set join field

    • setJoinEntity

      public void setJoinEntity(Entity entity)
      Parameters:
      entity - the join entity to set

    • getJoinProperty

      public Property getJoinProperty()
      Returns:
      the join property

    • setJoinProperty

      public void setJoinProperty(Property property)
      Parameters:
      property - the join property to set

    • getLoadFieldName

      public String getLoadFieldName()
      Returns:
      the load field name

    • setLoadFieldName

      public void setLoadFieldName(String fieldName)
      Parameters:
      fieldName - the load field name to set

    • getLoadField

      public Field getLoadField()
      Returns:
      the load field

    • setLoadField

      public Field setLoadField(Field field)
      Parameters:
      field - the load field to set
      Returns:
      the previously set load field

    • setLoadEntity

      public void setLoadEntity(Entity entity)
      Parameters:
      entity - the load entity to set

    • getLoadProperty

      public Property getLoadProperty()
      Returns:
      the load property

    • setLoadProperty

      public void setLoadProperty(Property property)
      Parameters:
      property - the load property to set

    • getTextFieldName

      public String getTextFieldName()
      Returns:
      the text field name

    • setTextFieldName

      public void setTextFieldName(String fieldName)
      Parameters:
      fieldName - the text field name to set

    • getTextField

      public Field getTextField()
      Returns:
      the text field

    • setTextField

      public Field setTextField(Field field)
      Parameters:
      field - the text field to set
      Returns:
      the previously set text field

    • setTextEntity

      public void setTextEntity(Entity entity)
      Parameters:
      entity - the text entity to set

    • getTextProperty

      public Property getTextProperty()
      Returns:
      the text property

    • setTextProperty

      public void setTextProperty(Property property)
      Parameters:
      property - the text property to set

    • getUpdateableFileReference

      public Kleenean getUpdateableFileReference()
      Returns:
      the updateable file reference indicator

    • setUpdateableFileReference

      public void setUpdateableFileReference(Kleenean updateable)
      Parameters:
      updateable - the updateable file reference indicator to set

    • isUpdateableFileReference

      public boolean isUpdateableFileReference()
      Returns:
      the updateable file reference indicator as boolean

    • getEmbeddedDocumentURLsJoint

      public String getEmbeddedDocumentURLsJoint()

    • getEmbeddedDocumentURLs

      public String[] getEmbeddedDocumentURLs()

    • setEmbeddedDocumentURLs

      public void setEmbeddedDocumentURLs(String... urls)

    • getEmbeddedDocumentType

      public EmbeddedDocumentType getEmbeddedDocumentType()

    • setEmbeddedDocumentType

      public void setEmbeddedDocumentType(EmbeddedDocumentType type)

    • getEmbeddedDocumentStyle

      public EmbeddedDocumentStyle getEmbeddedDocumentStyle()

    • setEmbeddedDocumentStyle

      public void setEmbeddedDocumentStyle(EmbeddedDocumentStyle style)

    • getLargeDisplayWidth

      public int getLargeDisplayWidth()

    • setLargeDisplayWidth

      public void setLargeDisplayWidth(int width)

    • getLargeDisplayHeight

      public int getLargeDisplayHeight()

    • setLargeDisplayHeight

      public void setLargeDisplayHeight(int height)

    • getMediumDisplayWidth

      public int getMediumDisplayWidth()

    • setMediumDisplayWidth

      public void setMediumDisplayWidth(int width)

    • getMediumDisplayHeight

      public int getMediumDisplayHeight()

    • setMediumDisplayHeight

      public void setMediumDisplayHeight(int height)

    • getSmallDisplayWidth

      public int getSmallDisplayWidth()

    • setSmallDisplayWidth

      public void setSmallDisplayWidth(int width)

    • getSmallDisplayHeight

      public int getSmallDisplayHeight()

    • setSmallDisplayHeight

      public void setSmallDisplayHeight(int height)

    • getDisplayWidth

      public int[] getDisplayWidth()

    • getDisplayHeight

      public int[] getDisplayHeight()

    • isResizable

      public boolean isResizable()

    • setResizable

      public void setResizable(boolean resizable)

    • getFrameBorder

      public Boolean getFrameBorder()

    • setFrameBorder

      public void setFrameBorder(Boolean frameBorder)

    • getEncryptedMedia

      public Boolean getEncryptedMedia()

    • setEncryptedMedia

      public void setEncryptedMedia(Boolean allow)

    • getAccelerometer

      public Boolean getAccelerometer()

    • setAccelerometer

      public void setAccelerometer(Boolean allow)

    • getAutoplay

      public Boolean getAutoplay()

    • setAutoplay

      public void setAutoplay(Boolean allow)

    • getGyroscope

      public Boolean getGyroscope()

    • setGyroscope

      public void setGyroscope(Boolean allow)

    • getPictureInPicture

      public Boolean getPictureInPicture()

    • setPictureInPicture

      public void setPictureInPicture(Boolean allow)

    • getFullScreen

      public Boolean getFullScreen()

    • setFullScreen

      public void setFullScreen(Boolean allow)

    • getLoading

      public EmbeddedDocumentLoading getLoading()

    • setLoading

      public void setLoading(EmbeddedDocumentLoading loading)

    • getReferrerPolicy

      public EmbeddedDocumentPolicy getReferrerPolicy()

    • setReferrerPolicy

      public void setReferrerPolicy(EmbeddedDocumentPolicy referrerPolicy)

    • getSandbox

      public EmbeddedDocumentSandbox getSandbox()

    • setSandbox

      public void setSandbox(EmbeddedDocumentSandbox sandbox)

    • toZeroPaddedString

      public CharacterOrderedPairX toZeroPaddedString()

    • fieldsToString

      protected String fieldsToString(int n, String key, boolean verbose, boolean fields, boolean maps)
      Overrides:
      fieldsToString in class AbstractDataArtifact