Class StringData

    • Constructor Detail

      • StringData

        public StringData()
    • Method Detail

      • 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 java.lang.Integer getMaxLength()
        Returns:
        the maxLength
      • setMaxLength

        public void setMaxLength​(java.lang.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()
      • getInputMask

        public java.lang.String getInputMask()
        Returns:
        the input mask
      • setInputMask

        public void setInputMask​(java.lang.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 java.util.regex.Pattern getPattern()
        Returns:
        the pattern
      • setPattern

        public void setPattern​(java.util.regex.Pattern pattern)
        Parameters:
        pattern - the pattern to set
      • getPatternRegex

        public java.lang.String getPatternRegex()
      • getDefaultRegexErrorMessage

        public java.lang.String getDefaultRegexErrorMessage()
        Returns:
        the default regex error message
      • setDefaultRegexErrorMessage

        public void setDefaultRegexErrorMessage​(java.lang.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 java.lang.String getLocalizedRegexErrorMessage​(java.util.Locale locale)
        Parameters:
        locale - the locale for the regex error message
        Returns:
        the localized regex error message
      • setLocalizedRegexErrorMessage

        public void setLocalizedRegexErrorMessage​(java.util.Locale locale,
                                                  java.lang.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
      • getAllowDiacritics

        public boolean getAllowDiacritics()
        Returns:
        the allow diacritics indicator
      • setAllowDiacritics

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

        public boolean getRichTextFormat()
        Returns:
        the rich text format indicator
      • setRichTextFormat

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

        public java.lang.String getSpecialConverterName()
        Returns:
        the special converter name
      • setSpecialConverterName

        public void setSpecialConverterName​(java.lang.String converter)
      • getSpecialValidatorName

        public java.lang.String getSpecialValidatorName()
        Returns:
        the special validator name
      • setSpecialValidatorName

        public void setSpecialValidatorName​(java.lang.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 java.lang.String getSourceURLsJoint()
      • getSourceURLs

        public java.lang.String[] getSourceURLs()
        Returns:
        the list of valid URLs
      • setSourceURLs

        public void setSourceURLs​(java.lang.String... urls)
        Parameters:
        urls - the list of valid URLs to set
      • getSearchURL

        public java.lang.String getSearchURL()
        Returns:
        the URL of the website to search for the value
      • setSearchURL

        public void setSearchURL​(java.lang.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:
        Class Base64
      • getEncodingType

        public EncodingType getEncodingType()
        Returns:
        the encoding type
      • 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:
        Class Base64
      • getFileDownloadStartFunction

        public java.lang.String getFileDownloadStartFunction()
      • setFileDownloadStartFunction

        public void setFileDownloadStartFunction​(java.lang.String function)
      • getFileDownloadStopFunction

        public java.lang.String getFileDownloadStopFunction()
      • setFileDownloadStopFunction

        public void setFileDownloadStopFunction​(java.lang.String function)
      • getFileViewerDialogReturnUpdate

        public java.lang.String getFileViewerDialogReturnUpdate()
      • setFileViewerDialogReturnUpdate

        public void setFileViewerDialogReturnUpdate​(java.lang.String... update)
      • isFileUploadAutoStart

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

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

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

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

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

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

        protected int maxInputFileSize()
      • 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 java.lang.String getValidInputFileTypesRegex()
      • getValidInputFilePattern

        public java.util.regex.Pattern getValidInputFilePattern()
        Returns:
        the valid input file pattern
      • setValidInputFilePattern

        public void setValidInputFilePattern​(java.util.regex.Pattern pattern)
        Parameters:
        pattern - the valid input file pattern to set
      • getValidInputFilePatternRegex

        public java.lang.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
      • getBlobFieldName

        public java.lang.String getBlobFieldName()
        Returns:
        the blob field name
      • setBlobFieldName

        public void setBlobFieldName​(java.lang.String fieldName)
        Parameters:
        fieldName - the blob field name to set
      • getBlobField

        public java.lang.reflect.Field getBlobField()
        Returns:
        the blob field
      • setBlobField

        public java.lang.reflect.Field setBlobField​(java.lang.reflect.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 java.lang.String getJoinFieldName()
        Returns:
        the join field name
      • setJoinFieldName

        public void setJoinFieldName​(java.lang.String fieldName)
        Parameters:
        fieldName - the join field name to set
      • getJoinField

        public java.lang.reflect.Field getJoinField()
        Returns:
        the join field
      • setJoinField

        public java.lang.reflect.Field setJoinField​(java.lang.reflect.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 java.lang.String getLoadFieldName()
        Returns:
        the load field name
      • setLoadFieldName

        public void setLoadFieldName​(java.lang.String fieldName)
        Parameters:
        fieldName - the load field name to set
      • getLoadField

        public java.lang.reflect.Field getLoadField()
        Returns:
        the load field
      • setLoadField

        public java.lang.reflect.Field setLoadField​(java.lang.reflect.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 java.lang.String getTextFieldName()
        Returns:
        the text field name
      • setTextFieldName

        public void setTextFieldName​(java.lang.String fieldName)
        Parameters:
        fieldName - the text field name to set
      • getTextField

        public java.lang.reflect.Field getTextField()
        Returns:
        the text field
      • setTextField

        public java.lang.reflect.Field setTextField​(java.lang.reflect.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 java.lang.String getEmbeddedDocumentURLsJoint()
      • getEmbeddedDocumentURLs

        public java.lang.String[] getEmbeddedDocumentURLs()
      • setEmbeddedDocumentURLs

        public void setEmbeddedDocumentURLs​(java.lang.String... urls)
      • 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)
      • isResizable

        public boolean isResizable()
      • setResizable

        public void setResizable​(boolean resizable)
      • getFrameBorder

        public java.lang.Boolean getFrameBorder()
      • setFrameBorder

        public void setFrameBorder​(java.lang.Boolean frameBorder)
      • getEncryptedMedia

        public java.lang.Boolean getEncryptedMedia()
      • setEncryptedMedia

        public void setEncryptedMedia​(java.lang.Boolean allow)
      • getAccelerometer

        public java.lang.Boolean getAccelerometer()
      • setAccelerometer

        public void setAccelerometer​(java.lang.Boolean allow)
      • getAutoplay

        public java.lang.Boolean getAutoplay()
      • setAutoplay

        public void setAutoplay​(java.lang.Boolean allow)
      • getGyroscope

        public java.lang.Boolean getGyroscope()
      • setGyroscope

        public void setGyroscope​(java.lang.Boolean allow)
      • getPictureInPicture

        public java.lang.Boolean getPictureInPicture()
      • setPictureInPicture

        public void setPictureInPicture​(java.lang.Boolean allow)
      • getFullScreen

        public java.lang.Boolean getFullScreen()
      • setFullScreen

        public void setFullScreen​(java.lang.Boolean allow)
      • fieldsToString

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