Package org.codelibs.fess.app.web.admin.fileconfig

Class CreateForm

java.lang.Object
org.codelibs.fess.app.web.admin.fileconfig.CreateForm
Direct Known Subclasses:
CreateBody, EditForm
public class CreateForm extends Object
The create form for File Config.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    @Required @Size(max=5) String
    available
    Whether this configuration is available for crawling (required, maximum 5 characters).
    @Required Float
    boost
    The boost value for search ranking (required).
    String
    configParameter
    Additional configuration parameters for the file crawler.
    @Size(max=1000) String
    createdBy
    The user who created this file configuration (maximum 1000 characters).
    Long
    createdTime
    The timestamp when this file configuration was created.
    Integer
    crudMode
    The CRUD operation mode for this form.
    @Min(0L) @Max(2147483647L) Integer
    depth
    The maximum crawling depth (0 to 2147483647, 0 means unlimited).
    @Size(max=1000) String
    description
    The description of the file configuration (maximum 1000 characters).
    String
    excludedDocPaths
    The document paths to exclude from search results (pattern-based).
    String
    excludedPaths
    The paths to exclude during crawling (pattern-based).
    String
    includedDocPaths
    The document paths to include in search results (pattern-based).
    String
    includedPaths
    The paths to include during crawling (pattern-based).
    @Required @Min(0L) @Max(2147483647L) Integer
    intervalTime
    The interval time between crawl requests in milliseconds (required, 0 to 2147483647).
    String[]
    labelTypeIds
    The IDs of label types associated with this file configuration.
    @Min(0L) @Max(9223372036854775807L) Long
    maxAccessCount
    The maximum number of documents to access during crawling (0 means unlimited).
    @Required @Size(max=200) String
    name
    The name of the file configuration (required, maximum 200 characters).
    @Required @Min(1L) @Max(2147483647L) Integer
    numOfThread
    The number of threads to use for crawling (required, 1 to 2147483647).
    @Required String
    paths
    The file paths to crawl (required, must be valid file URIs).
    String
    permissions
    The permissions required to access documents from this configuration.
    @Required @Min(0L) @Max(2147483647L) Integer
    sortOrder
    The sort order for this configuration (required, 0 to 2147483647).
    String
    virtualHosts
    The virtual hosts associated with this file configuration.

  • Constructor Summary

    Constructors
    Constructor
    Description
    CreateForm()
    Creates a new CreateForm instance.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    initialize()
    Initializes the form with default values for creation mode.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • labelTypeIds

      public String[] labelTypeIds
      The IDs of label types associated with this file configuration.

    • crudMode

      @ValidateTypeFailure public Integer crudMode
      The CRUD operation mode for this form.

    • name

      @Required @Size(max=200) public @Required @Size(max=200) String name
      The name of the file configuration (required, maximum 200 characters).

    • description

      @Size(max=1000) public @Size(max=1000) String description
      The description of the file configuration (maximum 1000 characters).

    • paths

      @Required @UriType(protocolType=FILE) @CustomSize(maxKey="form.admin.max.input.size") public @Required String paths
      The file paths to crawl (required, must be valid file URIs).

    • includedPaths

      @CustomSize(maxKey="form.admin.max.input.size") public String includedPaths
      The paths to include during crawling (pattern-based).

    • excludedPaths

      @CustomSize(maxKey="form.admin.max.input.size") public String excludedPaths
      The paths to exclude during crawling (pattern-based).

    • includedDocPaths

      @CustomSize(maxKey="form.admin.max.input.size") public String includedDocPaths
      The document paths to include in search results (pattern-based).

    • excludedDocPaths

      @CustomSize(maxKey="form.admin.max.input.size") public String excludedDocPaths
      The document paths to exclude from search results (pattern-based).

    • configParameter

      @CustomSize(maxKey="form.admin.max.input.size") public String configParameter
      Additional configuration parameters for the file crawler.

    • depth

      @Min(0L) @Max(2147483647L) @ValidateTypeFailure public @Min(0L) @Max(2147483647L) Integer depth
      The maximum crawling depth (0 to 2147483647, 0 means unlimited).

    • maxAccessCount

      @Min(0L) @Max(9223372036854775807L) @ValidateTypeFailure public @Min(0L) @Max(9223372036854775807L) Long maxAccessCount
      The maximum number of documents to access during crawling (0 means unlimited).

    • numOfThread

      @Required @Min(1L) @Max(2147483647L) @ValidateTypeFailure public @Required @Min(1L) @Max(2147483647L) Integer numOfThread
      The number of threads to use for crawling (required, 1 to 2147483647).

    • intervalTime

      @Required @Min(0L) @Max(2147483647L) @ValidateTypeFailure public @Required @Min(0L) @Max(2147483647L) Integer intervalTime
      The interval time between crawl requests in milliseconds (required, 0 to 2147483647).

    • boost

      @Required @ValidateTypeFailure public @Required Float boost
      The boost value for search ranking (required).

    • available

      @Required @Size(max=5) public @Required @Size(max=5) String available
      Whether this configuration is available for crawling (required, maximum 5 characters).

    • permissions

      @CustomSize(maxKey="form.admin.max.input.size") public String permissions
      The permissions required to access documents from this configuration.

    • virtualHosts

      @CustomSize(maxKey="form.admin.max.input.size") public String virtualHosts
      The virtual hosts associated with this file configuration.

    • sortOrder

      @Required @Min(0L) @Max(2147483647L) @ValidateTypeFailure public @Required @Min(0L) @Max(2147483647L) Integer sortOrder
      The sort order for this configuration (required, 0 to 2147483647).

    • createdBy

      @Size(max=1000) public @Size(max=1000) String createdBy
      The user who created this file configuration (maximum 1000 characters).

    • createdTime

      @ValidateTypeFailure public Long createdTime
      The timestamp when this file configuration was created.

  • Constructor Details

    • CreateForm

      public CreateForm()
      Creates a new CreateForm instance.

  • Method Details

    • initialize

      public void initialize()
      Initializes the form with default values for creation mode.