Package com.logicaldoc.impex

Class 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

    • Constructor Detail

      • 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 Detail

      • getFile

        public File getFile()

      • marshall

        public void marshall()
              throws IOException
        Writes the index file to index.xml
        Throws:
        IOException - Raised on disk errors

      • marshall

        public void marshall​(Writer writer)
              throws IOException
        Writes the index file
        Parameters:
        writer - The writer to write to
        Throws:
        IOException - Raised on disk errors

      • getBarcodeTemplateName

        public static String getBarcodeTemplateName​(Long id)

      • getBarcodeTemplateId

        public static Long getBarcodeTemplateId​(String name)

      • getOcrTemplateName

        public static String getOcrTemplateName​(Long id)

      • 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()