Interface SplitService
-
- All Known Implementing Classes:
SoapSplitClient
,SoapSplitService
public interface SplitService
WebService to allow a user to split documents- Since:
- 8.4
- Author:
- Marco Meschieri - LogicalDOC
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Long[]
splitAllPages(String sid, long docId)
Splits a PDF document, each page in a different fileLong[]
splitSelection(String sid, long docId, String expression)
Splits a PDF document in a selection of pagesLong[]
splitUsingBarcode(String sid, long docId, String expression, int separator)
Splits a PDF document using a barcode as separatorLong[]
splitUsingBlankPage(String sid, long docId, int separator)
Splits a PDF document using a blank page as separatorLong[]
splitUsingText(String sid, long docId, String expression, int separator)
Splits a PDF document using a text as separator
-
-
-
Method Detail
-
splitAllPages
Long[] splitAllPages(String sid, long docId) throws Exception
Splits a PDF document, each page in a different file- Parameters:
sid
- identifier of the sessiondocId
- identifier of the document- Returns:
- identifiers of the created segments
- Throws:
Exception
- error in the server
-
splitSelection
Long[] splitSelection(String sid, long docId, String expression) throws Exception
Splits a PDF document in a selection of pages- Parameters:
sid
- identifier of the sessiondocId
- identifier of the documentexpression
- the selection of pages (e.g.: 1,2,4-6,9)- Returns:
- identifiers of the created segments
- Throws:
Exception
- error in the server
-
splitUsingBlankPage
Long[] splitUsingBlankPage(String sid, long docId, int separator) throws Exception
Splits a PDF document using a blank page as separator- Parameters:
sid
- identifier of the sessiondocId
- identifier of the documentseparator
- 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
Long[] splitUsingBarcode(String sid, long docId, String expression, int separator) throws Exception
Splits a PDF document using a barcode as separator- Parameters:
sid
- identifier of the sessiondocId
- identifier of the documentexpression
- regular expression that must be matched by the barcode's value, seePattern
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
Long[] splitUsingText(String sid, long docId, String expression, int separator) throws Exception
Splits a PDF document using a text as separator- Parameters:
sid
- identifier of the sessiondocId
- identifier of the documentexpression
- regular expression that must be matched by the text, seePattern
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
-
-