Splitter
Inheritance: java.lang.Object
public class Splitter
Provides methods intended to split the documents into parts using different criteria.
Methods
extractPages(InputStream inputStream, OutputStream outputStream, SaveOptions saveOptions, int startPageIndex, int pageCount)
public static void extractPages(InputStream inputStream, OutputStream outputStream, SaveOptions saveOptions, int startPageIndex, int pageCount)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| inputStream | java.io.InputStream | |
| outputStream | java.io.OutputStream | |
| saveOptions | SaveOptions | |
| startPageIndex | int | |
| pageCount | int |
extractPages(InputStream inputStream, OutputStream outputStream, int saveFormat, int startPageIndex, int pageCount)
public static void extractPages(InputStream inputStream, OutputStream outputStream, int saveFormat, int startPageIndex, int pageCount)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| inputStream | java.io.InputStream | |
| outputStream | java.io.OutputStream | |
| saveFormat | int | |
| startPageIndex | int | |
| pageCount | int |
extractPages(String inputFileName, String outputFileName, SaveOptions saveOptions, int startPageIndex, int pageCount)
public static void extractPages(String inputFileName, String outputFileName, SaveOptions saveOptions, int startPageIndex, int pageCount)
Extracts a specified range of pages from a document file and saves the extracted pages to a new file using the specified save format.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| inputFileName | java.lang.String | The input file name. |
| outputFileName | java.lang.String | The output file name. |
| saveOptions | SaveOptions | The save options. |
| startPageIndex | int | The zero-based index of the first page to extract. |
| pageCount | int | Number of pages to be extracted. |
extractPages(String inputFileName, String outputFileName, int startPageIndex, int pageCount)
public static void extractPages(String inputFileName, String outputFileName, int startPageIndex, int pageCount)
Extracts a specified range of pages from a document file and saves the extracted pages to a new file. The output file format is determined by the extension of the output file name.
Examples:
Shows how to extract pages from the document.
// There is a several ways to extract pages from the document:
String doc = getMyDir() + "Big document.docx";
Splitter.extractPages(doc, getArtifactsDir() + "LowCode.ExtractPages.1.docx", 0, 2);
Splitter.extractPages(doc, getArtifactsDir() + "LowCode.ExtractPages.2.docx", SaveFormat.DOCX, 0, 2);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| inputFileName | java.lang.String | The input file name. |
| outputFileName | java.lang.String | The output file name. |
| startPageIndex | int | The zero-based index of the first page to extract. |
| pageCount | int | Number of pages to be extracted. |
extractPages(String inputFileName, String outputFileName, int saveFormat, int startPageIndex, int pageCount)
public static void extractPages(String inputFileName, String outputFileName, int saveFormat, int startPageIndex, int pageCount)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| inputFileName | java.lang.String | |
| outputFileName | java.lang.String | |
| saveFormat | int | |
| startPageIndex | int | |
| pageCount | int |
removeBlankPages(InputStream inputStream, OutputStream outputStream, SaveOptions saveOptions)
public static ArrayList removeBlankPages(InputStream inputStream, OutputStream outputStream, SaveOptions saveOptions)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| inputStream | java.io.InputStream | |
| outputStream | java.io.OutputStream | |
| saveOptions | SaveOptions |
Returns: java.util.ArrayList
removeBlankPages(InputStream inputStream, OutputStream outputStream, int saveFormat)
public static ArrayList removeBlankPages(InputStream inputStream, OutputStream outputStream, int saveFormat)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| inputStream | java.io.InputStream | |
| outputStream | java.io.OutputStream | |
| saveFormat | int |
Returns: java.util.ArrayList
removeBlankPages(String inputFileName, String outputFileName)
public static ArrayList removeBlankPages(String inputFileName, String outputFileName)
Removes empty pages from the document and saves the output. Returns a list of page numbers that were removed.
Examples:
Shows how to remove empty pages from the document.
// There is a several ways to remove empty pages from the document:
String doc = getMyDir() + "Blank pages.docx";
Splitter.removeBlankPages(doc, getArtifactsDir() + "LowCode.RemoveBlankPages.1.docx");
Splitter.removeBlankPages(doc, getArtifactsDir() + "LowCode.RemoveBlankPages.2.docx", SaveFormat.DOCX);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| inputFileName | java.lang.String | The input file name. |
| outputFileName | java.lang.String | The output file name. |
Returns: java.util.ArrayList - List of page numbers has been considered as blank and removed.
removeBlankPages(String inputFileName, String outputFileName, SaveOptions saveOptions)
public static ArrayList removeBlankPages(String inputFileName, String outputFileName, SaveOptions saveOptions)
Removes empty pages from the document and saves the output in the specified format. Returns a list of page numbers that were removed.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| inputFileName | java.lang.String | The input file name. |
| outputFileName | java.lang.String | The output file name. |
| saveOptions | SaveOptions | The save options. |
Returns: java.util.ArrayList - List of page numbers has been considered as blank and removed.
removeBlankPages(String inputFileName, String outputFileName, int saveFormat)
public static ArrayList removeBlankPages(String inputFileName, String outputFileName, int saveFormat)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| inputFileName | java.lang.String | |
| outputFileName | java.lang.String | |
| saveFormat | int |
Returns: java.util.ArrayList
split(InputStream inputStream, SaveOptions saveOptions, SplitOptions options)
public static InputStream[] split(InputStream inputStream, SaveOptions saveOptions, SplitOptions options)
Splits a document from an input stream into multiple parts based on the specified split options and returns the resulting parts as an array of streams in the specified save format.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| inputStream | java.io.InputStream | The input stream. |
| saveOptions | SaveOptions | The save options. |
| options | SplitOptions | Document split options. |
Returns: java.io.InputStream[]
split(InputStream inputStream, int saveFormat, SplitOptions options)
public static InputStream[] split(InputStream inputStream, int saveFormat, SplitOptions options)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| inputStream | java.io.InputStream | |
| saveFormat | int | |
| options | SplitOptions |
Returns: java.io.InputStream[]
split(String inputFileName, String outputFileName, SaveOptions saveOptions, SplitOptions options)
public static void split(String inputFileName, String outputFileName, SaveOptions saveOptions, SplitOptions options)
Splits a document into multiple parts based on the specified split options and saves the resulting parts to files in the specified save format.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| inputFileName | java.lang.String | The input file name. |
| outputFileName | java.lang.String | The output file name used to generate file name for document parts using rule “outputFile_partIndex.extension” |
| saveOptions | SaveOptions | The save options. |
| options | SplitOptions | Document split options. |
split(String inputFileName, String outputFileName, SplitOptions options)
public static void split(String inputFileName, String outputFileName, SplitOptions options)
Splits a document into multiple parts based on the specified split options and saves the resulting parts to files. The output file format is determined by the extension of the output file name.
Examples:
Shows how to split document by pages.
String doc = getMyDir() + "Big document.docx";
SplitOptions options = new SplitOptions();
options.setSplitCriteria(SplitCriteria.PAGE);
Splitter.split(doc, getArtifactsDir() + "LowCode.SplitDocument.1.docx", options);
Splitter.split(doc, getArtifactsDir() + "LowCode.SplitDocument.2.docx", SaveFormat.DOCX, options);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| inputFileName | java.lang.String | The input file name. |
| outputFileName | java.lang.String | The output file name used to generate file name for document parts using rule “outputFile_partIndex.extension” |
| options | SplitOptions | Document split options. |
split(String inputFileName, String outputFileName, int saveFormat, SplitOptions options)
public static void split(String inputFileName, String outputFileName, int saveFormat, SplitOptions options)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| inputFileName | java.lang.String | |
| outputFileName | java.lang.String | |
| saveFormat | int | |
| options | SplitOptions |