Class SoapSplitService

  • All Implemented Interfaces:
    SplitService

    public class SoapSplitService
    extends com.logicaldoc.webservice.AbstractService
    implements SplitService
    Implementation of the Split webservice
    Since:
    8.4
    Author:
    Marco Meschieri - LogicalDOC
    • Constructor Detail

      • SoapSplitService

        public SoapSplitService()
    • Method Detail

      • splitAllPages

        public Long[] splitAllPages​(String sid,
                                    long docId)
                             throws Exception
        Description copied from interface: SplitService
        Splits a PDF document, each page in a different file
        Specified by:
        splitAllPages in interface SplitService
        Parameters:
        sid - identifier of the session
        docId - identifier of the document
        Returns:
        identifiers of the created segments
        Throws:
        Exception - error in the server
      • splitSelection

        public Long[] splitSelection​(String sid,
                                     long docId,
                                     String expression)
                              throws Exception
        Description copied from interface: SplitService
        Splits a PDF document in a selection of pages
        Specified by:
        splitSelection in interface SplitService
        Parameters:
        sid - identifier of the session
        docId - identifier of the document
        expression - the selection of pages (e.g.: 1,2,4-6,9)
        Returns:
        identifiers of the created segments
        Throws:
        Exception - error in the server
      • splitUsingBlankPage

        public Long[] splitUsingBlankPage​(String sid,
                                          long docId,
                                          int separator)
                                   throws Exception
        Description copied from interface: SplitService
        Splits a PDF document using a blank page as separator
        Specified by:
        splitUsingBlankPage in interface SplitService
        Parameters:
        sid - identifier of the session
        docId - identifier of the document
        separator - how to handle the separator: 0 = skip, 1 = append to current segment, 2 = prepend to next segment
        Returns:
        identifiers of the created segments
        Throws:
        Exception - error in the server
      • splitUsingBarcode

        public Long[] splitUsingBarcode​(String sid,
                                        long docId,
                                        String expression,
                                        int separator)
                                 throws Exception
        Description copied from interface: SplitService
        Splits a PDF document using a barcode as separator
        Specified by:
        splitUsingBarcode in interface SplitService
        Parameters:
        sid - identifier of the session
        docId - identifier of the document
        expression - regular expression that must be matched by the barcode's value, see Pattern
        separator - how to handle the separator: 0 = skip, 1 = append to current segment, 2 = prepend to next segment
        Returns:
        identifiers of the created segments
        Throws:
        Exception - error in the server
      • splitUsingText

        public Long[] splitUsingText​(String sid,
                                     long docId,
                                     String expression,
                                     int separator)
                              throws Exception
        Description copied from interface: SplitService
        Splits a PDF document using a text as separator
        Specified by:
        splitUsingText in interface SplitService
        Parameters:
        sid - identifier of the session
        docId - identifier of the document
        expression - regular expression that must be matched by the text, see Pattern
        separator - how to handle the separator: 0 = skip, 1 = append to current segment, 2 = prepend to next segment
        Returns:
        identifiers of the created segments
        Throws:
        Exception - error in the server