Package adalid.core.annotations

Annotation Interface FileReference

@Retention(RUNTIME) @Target(FIELD) public @interface FileReference
La anotación FileReference se utiliza para designar propiedades y parámetros String como referencias a archivos cargados en el servidor.
Author:
Jorge Campins

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    Kleenean
    autoStart
    autoStart específica si la operación de carga debe, o no, comenzar automáticamente al seleccionar los archivos.
    String
    blobField
    blobField especifica el nombre de la propiedad donde se almacena el contenido del archivo.
    int
    fileLimit
    fileLimit específica el número máximo de archivos que se pueden cargar en una misma operación.
    String
    joinField
    joinField especifica el nombre de la propiedad que hace referencia a la tabla de la base de datos donde se almacena el contenido del archivo.
    String
    loadField
    loadField especifica el nombre de la propiedad donde se almacena la fecha y la hora en que se cargó el archivo.
    int
    max
    max específica el tamaño máximo (en bytes) de los archivos que se pueden cargar.
    String
    pathTemplate
    pathTemplate especifica la plantilla de ruta de los archivos cargados en el servidor de aplicaciones.
    String
    regex
    regex especifica la expresión regular que deben satisfacer los nombres de los archivos que se pueden cargar.
    UploadStorageOption
    storage
    storage especifica el tipo de almacenamiento de los archivos cargados.
    String
    textField
    textField especifica el nombre de la propiedad donde se almacena la descripción del archivo.
    MimeType[]
    types
    types especifica una o más extensiones MIME (Multipurpose Internet Mail Extensions) que puede cargar la operación.
    int
    undoLimit
    undoLimit específica el número máximo de veces que se puede eliminar y volver a cargar los archivos en una misma operación.
    Kleenean
    virusScan
    virusScan específica si la operación de carga debe, o no, escanear los archivos cargados.

  • Element Details

    • autoStart

      Kleenean autoStart
      autoStart específica si la operación de carga debe, o no, comenzar automáticamente al seleccionar los archivos. Su valor es uno de los elementos de la enumeración Kleenean. Seleccione TRUE para comenzar la carga automáticamente; en caso contrario, seleccione FALSE. Alternativamente, omita el elemento o seleccione UNSPECIFIED para utilizar el valor predeterminado del atributo. El valor predeterminado del atributo es FALSE.
      Returns:
      autoStart
      Default:
      UNSPECIFIED

    • virusScan

      Kleenean virusScan
      virusScan específica si la operación de carga debe, o no, escanear los archivos cargados. Su valor es uno de los elementos de la enumeración Kleenean. Seleccione TRUE para escanear los archivos cargados; en caso contrario, seleccione FALSE. Alternativamente, omita el elemento o seleccione UNSPECIFIED para utilizar el valor predeterminado del atributo. El valor predeterminado del atributo es FALSE.
      Returns:
      autoStart
      Default:
      UNSPECIFIED

    • fileLimit

      int fileLimit
      fileLimit específica el número máximo de archivos que se pueden cargar en una misma operación. Su valor debe ser un número entero, mayor o igual a 1 y menor o igual a 100. El valor predeterminado es 1.
      Returns:
      fileLimit
      Default:
      -1

    • undoLimit

      int undoLimit
      undoLimit específica el número máximo de veces que se puede eliminar y volver a cargar los archivos en una misma operación. Su valor debe ser un número entero, mayor o igual a 0 y menor o igual a 4. El valor predeterminado es 2.
      Returns:
      undoLimit
      Default:
      -1

    • max

      int max
      max específica el tamaño máximo (en bytes) de los archivos que se pueden cargar. Su valor debe ser un número entero, mayor o igual a 0. Especifique 0 para permitir la carga de archivos hasta el tamaño máximo permitido por la configuración del servidor de aplicaciones. Alternativamente, omita el elemento para utilizar el valor predeterminado del atributo. El valor predeterminado es 100.000 (100 KB).
      Returns:
      max
      Default:
      -1

    • types

      MimeType[] types
      types especifica una o más extensiones MIME (Multipurpose Internet Mail Extensions) que puede cargar la operación. Su valor es una lista de elementos de la enumeración MimeType. Omita el elemento para permitir la carga de archivos con cualquier extensión. El valor de este elemento también se puede especificar mediante el método setValidInputFileTypes.
      Returns:
      types
      Default:
      {}

    • regex

      String regex
      regex especifica la expresión regular que deben satisfacer los nombres de los archivos que se pueden cargar. Para más información sobre expresiones regulares consulte la documentación de Java (la página Regular Expressions es un buen punto de partida). Advertencia: la expresión debe ser válida tanto en Java como en JavaScript y, por lo tanto, no debe contener características específicas de ninguno de los dos lenguajes.
      Returns:
      regex
      Default:
      ""

    • storage

      UploadStorageOption storage
      storage especifica el tipo de almacenamiento de los archivos cargados. Su valor es uno de los elementos de la enumeración UploadStorageOption. Seleccione FILE, ROW o ROW_AND_FILE para almacenar el archivo en el servidor de aplicaciones (web), en la base de datos, o en ambos, respectivamente. Alternativamente, omita el elemento para utilizar el valor predeterminado del atributo. El valor predeterminado es ROW_AND_FILE.
      Returns:
      storage
      Default:
      UNSPECIFIED

    • pathTemplate

      String pathTemplate
      pathTemplate especifica la plantilla de ruta de los archivos cargados en el servidor de aplicaciones. La ruta del archivo se personaliza mediante esta plantilla, la cual puede contener secuencias de letras, números, guiones y guiones bajos (underscores), y una o más claves de elementos de datos. Las claves se deben encerrar entre llaves. La plantilla también puede contener nombres de propiedades de la entidad, encerrados entre corchetes; estos nombres son reemplazados por el valor que tiene la propiedad en la instancia de la entidad que corresponde al archivo cargado. Los elementos de la plantilla se pueden separar con puntos; esos puntos son reemplazados por el carácter de separación de rutas propio del sistema operativo: barra diagonal para Linux y barra diagonal invertida para Windows.

      Las claves de elementos de datos válidas son:

      • EntityName: nombre de la entidad que corresponde al archivo cargado.
      • References: nombre de la propiedad de la entidad, o de la operación y el parámetro, que corresponde al archivo cargado.
      • InstancePK: clave primaria (id) de la instancia de la entidad que corresponde al archivo cargado.
      • InstanceBK: clave de negocio (código) de la instancia de la entidad que corresponde al archivo cargado.
      • UploadDate: fecha (yyyyMMdd) de carga del archivo.
      • UploadYear: año (yyyy) de carga del archivo.
      • UploadMonth: mes (MM) de carga del archivo.
      • UploadDay: dia del mes (dd) de carga del archivo.
      • UploadTime: hora (HHmm) de carga del archivo.
      • UploadUserPK: clave primaria (id) del usuario que ejecuta la carga del archivo.
      • UploadUserBK: clave de negocio (código) del usuario que ejecuta la carga del archivo.
      La plantilla predeterminada es {EntityName}.{References}.{UploadDate}
      Returns:
      path
      Default:
      ""

    • blobField

      String blobField
      blobField especifica el nombre de la propiedad donde se almacena el contenido del archivo. Este elemento es relevante solo si el valor especificado, o determinado, para el elemento storage es ROW o ROW_AND_FILE.
      Returns:
      blobField
      Default:
      ""

    • joinField

      String joinField
      joinField especifica el nombre de la propiedad que hace referencia a la tabla de la base de datos donde se almacena el contenido del archivo. Este elemento es relevante solo si el valor especificado, o determinado, para el elemento storage es ROW o ROW_AND_FILE.
      Returns:
      joinField
      Default:
      ""

    • loadField

      String loadField
      loadField especifica el nombre de la propiedad donde se almacena la fecha y la hora en que se cargó el archivo. La clase de la propiedad especificada debe ser DateProperty o TimestampProperty.
      Returns:
      loadField
      Default:
      ""

    • textField

      String textField
      textField especifica el nombre de la propiedad donde se almacena la descripción del archivo. La clase de la propiedad especificada debe ser StringProperty.
      Returns:
      textField
      Default:
      ""