Package org.ctan.site.domain.archive

Class ArchiveFile

java.lang.Object
org.ctan.site.domain.archive.ArchiveFile
All Implemented Interfaces:
Searchable
@Entity(name="archive_file") public class ArchiveFile extends Object implements Searchable
This domain class records the info about a file or directory in the tex-archive tree.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    ArchiveFile.FileType
    This enumeration lists known file types.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ArchiveFile()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    indexPath()
    The method indexPath provides means to retrieve the URL under which the entity is indexed.
    boolean
    isArchive()
    This method is a getter for the boolean property of a file being an archive.
    boolean
    isDirectory()
    This method is a getter for the boolean property of a file being a directory.
    boolean
    isFile()
    This method is a getter for the boolean property of a file being a plain file.
    Map<String,Object>
    toMap()
    The method toMap provides means to get the instance as Map.
    void
    updateIndex(IndexingSession session)
    The method updateIndex provides means to update the entity in the search index.

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.ctan.site.services.search.base.Searchable

    getId

  • Constructor Details

    • ArchiveFile

      public ArchiveFile()

  • Method Details

    • indexPath

      public String indexPath()
      The method indexPath provides means to retrieve the URL under which the entity is indexed.
      Specified by:
      indexPath in interface Searchable
      Returns:
      the URL
      See Also:

    • isArchive

      public boolean isArchive()
      This method is a getter for the boolean property of a file being an archive.
      Returns:
      true iff the file is an archive

    • isDirectory

      public boolean isDirectory()
      This method is a getter for the boolean property of a file being a directory.
      Returns:
      true iff the file is a directory

    • isFile

      public boolean isFile()
      This method is a getter for the boolean property of a file being a plain file.
      Returns:
      true iff the file is a plain file

    • toMap

      public Map<String,Object> toMap()
      The method toMap provides means to get the instance as Map.
      Returns:
      the Map representation

    • updateIndex

      public void updateIndex(IndexingSession session) throws org.apache.lucene.index.CorruptIndexException, IOException
      The method updateIndex provides means to update the entity in the search index.
      Specified by:
      updateIndex in interface Searchable
      Parameters:
      session - the session
      Throws:
      org.apache.lucene.index.CorruptIndexException - in case of an error
      IOException - in case of an I/O error
      See Also: