Package com.logicaldoc.impex

Class Index

java.lang.Object
com.logicaldoc.impex.Index
public class Index extends Object
This bean is used to write the archive's index file and to read all informations regarding all documents into the archive.
Since:
4.5
Author:
Matteo Caruso - LogicalDOC

  • Field Details

  • Constructor Details

    • Index

      public Index(Archive archive)

    • Index

      public Index(File file)

    • Index

      public Index(byte[] indexContent, IndexHandler handler)
      Constructor used on the ArchiveVerifier class. This method unmarshalls the index file stream
      Parameters:
      indexContent - the bytes of the index file
      handler - the handler to be used to process the file

    • Index

      public Index(File file, IndexHandler handler)
      Constructor used on the ArchiveVerifier class. This method unmarshalls the index file
      Parameters:
      file - the index.xml file
      handler - the handler to be used to process the file

    • Index

      public Index(byte[] indexContent, IndexImportHandler handler)
      Constructor used on the ArchiveImporter class. This method unmarshalls the index file stream and allows to get the archive's documents list
      Parameters:
      indexContent - content of the index.xml file
      handler - the handler to be used to process the file

  • Method Details

    • getFile

      public File getFile()

    • marshall

      public void marshall() throws IOException, com.logicaldoc.core.PersistenceException
      Writes the index file to index.xml
      Throws:
      IOException - Raised on disk errors
      com.logicaldoc.core.PersistenceException - error at data layer

    • marshall

      public void marshall(Writer writer) throws IOException, com.logicaldoc.core.PersistenceException
      Writes the index file
      Parameters:
      writer - The writer to write to
      Throws:
      IOException - Raised on disk errors
      com.logicaldoc.core.PersistenceException - error at data layer

    • getTemplateName

      public static String getTemplateName(Long id, boolean barcodeTemplate)

    • getBarcodeTemplateId

      public static Long getBarcodeTemplateId(String name)

    • getOcrTemplateId

      public static Long getOcrTemplateId(String name)

    • unmarshall

      public void unmarshall()
      Reads the index from a file

    • unmarshall

      public void unmarshall(IndexHandler dataHandler)
      Reads the index from a file
      Parameters:
      dataHandler - the handler to be used to process the file

    • unmarshall

      public void unmarshall(byte[] indexContent, IndexHandler dataHandler)
      Reads the index from a stream and sets the archive attributes and each archive's version values
      Parameters:
      indexContent - content of the index file
      dataHandler - the handler to be used to process the file

    • unmarshall

      public void unmarshall(InputStream is, IndexHandler dataHandler)
      Reads the index from a stream and sets the archive attributes and each archive's version values
      Parameters:
      is - the stream to read the index file content
      dataHandler - the handler to be used to process the file

    • getArchive

      public Archive getArchive()

    • setArchive

      public void setArchive(Archive archive)

    • getCount

      public long getCount()

    • getSizedisplay

      public String getSizedisplay()

    • getProgramVersion

      public String getProgramVersion()

    • getArchiveVersion

      public String getArchiveVersion()