com.aspose.words

Class Splitter

java.lang.Object

com.aspose.words.Processor

com.aspose.words.Splitter

public class Splitter
extends Processor

Provides methods intended to split the documents into parts using different criteria.

Field Summary

Fields inherited from class com.aspose.words.Processor

mResultDocument

Method Summary

Modifier and Type	Method and Description
static Splitter	create(SplitterContext context) Creates new instance of the splitter processor.
protected void	executeCore()
static void	extractPages(java.io.InputStream inputStream, java.io.OutputStream outputStream, int saveFormat, int startPageIndex, int pageCount)
static void	extractPages(java.io.InputStream inputStream, java.io.OutputStream outputStream, SaveOptions saveOptions, int startPageIndex, int pageCount)
static void	extractPages(java.lang.String inputFileName, java.lang.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.
static void	extractPages(java.lang.String inputFileName, java.lang.String outputFileName, int saveFormat, int startPageIndex, int pageCount)
static void	extractPages(java.lang.String inputFileName, java.lang.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.
static java.util.ArrayList	removeBlankPages(java.io.InputStream inputStream, java.io.OutputStream outputStream, int saveFormat)
static java.util.ArrayList	removeBlankPages(java.io.InputStream inputStream, java.io.OutputStream outputStream, SaveOptions saveOptions)
static java.util.ArrayList	removeBlankPages(java.lang.String inputFileName, java.lang.String outputFileName) Removes empty pages from the document and saves the output.
static java.util.ArrayList	removeBlankPages(java.lang.String inputFileName, java.lang.String outputFileName, int saveFormat)
static java.util.ArrayList	removeBlankPages(java.lang.String inputFileName, java.lang.String outputFileName, SaveOptions saveOptions) Removes empty pages from the document and saves the output in the specified format.
static java.io.OutputStream[]	split(java.io.InputStream inputStream, int saveFormat, SplitOptions options)
static java.io.OutputStream[]	split(java.io.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.
static void	split(java.lang.String inputFileName, java.lang.String outputFileName, int saveFormat, SplitOptions options)
static void	split(java.lang.String inputFileName, java.lang.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.
static void	split(java.lang.String inputFileName, java.lang.String outputFileName, SplitOptions options) Splits a document into multiple parts based on the specified split options and saves the resulting parts to files.

Methods inherited from class com.aspose.words.Processor

checkArgumentsSet, execute, from, from, from, from, getPartFileName, to, to, to, to, to, to, to, toOutput, toOutput

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static Splitter create(SplitterContext context)

Creates new instance of the splitter processor.

Examples:

Shows how to split document by pages using context.

 
 String doc = getMyDir() + "Big document.docx";

 SplitterContext splitterContext = new SplitterContext();
 splitterContext.getSplitOptions().setSplitCriteria(SplitCriteria.PAGE);

 Splitter.create(splitterContext)
         .from(doc)
         .to(getArtifactsDir() + "LowCode.SplitContextDocument.docx")
         .execute();
 
 

Shows how to split document from the stream by pages using context.

 
 try (FileInputStream streamIn = new FileInputStream(getMyDir() + "Big document.docx")) {
     SplitterContext splitterContext = new SplitterContext();
     splitterContext.getSplitOptions().setSplitCriteria(SplitCriteria.PAGE);

     ArrayList<OutputStream> pages = new ArrayList<>();
     Splitter.create(splitterContext)
             .from(streamIn)
             .toOutput(pages, SaveFormat.DOCX)
             .execute();
 }
 
 

executeCore

protected void executeCore()
                    throws java.lang.Exception

Overrides:

executeCore in class Processor

Throws:

java.lang.Exception

removeBlankPages

public static java.util.ArrayList removeBlankPages(java.lang.String inputFileName,
                                                   java.lang.String outputFileName)
                                            throws java.lang.Exception

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:

inputFileName - The input file name.

outputFileName - The output file name.

Returns:

List of page numbers has been considered as blank and removed.

Throws:

java.lang.Exception

removeBlankPages

public static java.util.ArrayList removeBlankPages(java.lang.String inputFileName,
                                                   java.lang.String outputFileName,
                                                   int saveFormat)
                                            throws java.lang.Exception

Throws:

java.lang.Exception

removeBlankPages

public static java.util.ArrayList removeBlankPages(java.lang.String inputFileName,
                                                   java.lang.String outputFileName,
                                                   SaveOptions saveOptions)
                                            throws java.lang.Exception

Removes empty pages from the document and saves the output in the specified format. Returns a list of page numbers that were removed.

Parameters:

inputFileName - The input file name.

outputFileName - The output file name.

saveOptions - The save options.

Returns:

List of page numbers has been considered as blank and removed.

Throws:

java.lang.Exception

removeBlankPages

public static java.util.ArrayList removeBlankPages(java.io.InputStream inputStream,
                                                   java.io.OutputStream outputStream,
                                                   int saveFormat)
                                            throws java.lang.Exception

Throws:

java.lang.Exception

removeBlankPages

public static java.util.ArrayList removeBlankPages(java.io.InputStream inputStream,
                                                   java.io.OutputStream outputStream,
                                                   SaveOptions saveOptions)
                                            throws java.lang.Exception

Throws:

java.lang.Exception

extractPages

public static void extractPages(java.lang.String inputFileName,
                                java.lang.String outputFileName,
                                int startPageIndex,
                                int pageCount)
                         throws java.lang.Exception

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:

inputFileName - The input file name.

outputFileName - The output file name.

startPageIndex - The zero-based index of the first page to extract.

pageCount - Number of pages to be extracted.

Throws:

java.lang.Exception

extractPages

public static void extractPages(java.lang.String inputFileName,
                                java.lang.String outputFileName,
                                int saveFormat,
                                int startPageIndex,
                                int pageCount)
                         throws java.lang.Exception

Throws:

java.lang.Exception

extractPages

public static void extractPages(java.lang.String inputFileName,
                                java.lang.String outputFileName,
                                SaveOptions saveOptions,
                                int startPageIndex,
                                int pageCount)
                         throws java.lang.Exception

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:

inputFileName - The input file name.

outputFileName - The output file name.

saveOptions - The save options.

startPageIndex - The zero-based index of the first page to extract.

pageCount - Number of pages to be extracted.

Throws:

java.lang.Exception

extractPages

public static void extractPages(java.io.InputStream inputStream,
                                java.io.OutputStream outputStream,
                                int saveFormat,
                                int startPageIndex,
                                int pageCount)
                         throws java.lang.Exception

Throws:

java.lang.Exception

extractPages

public static void extractPages(java.io.InputStream inputStream,
                                java.io.OutputStream outputStream,
                                SaveOptions saveOptions,
                                int startPageIndex,
                                int pageCount)
                         throws java.lang.Exception

Throws:

java.lang.Exception

split

public static void split(java.lang.String inputFileName,
                         java.lang.String outputFileName,
                         SplitOptions options)
                  throws java.lang.Exception

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:

inputFileName - The input file name.

outputFileName - The output file name used to generate file name for document parts using rule "outputFile_partIndex.extension"

options - Document split options.

Throws:

java.lang.Exception

split

public static void split(java.lang.String inputFileName,
                         java.lang.String outputFileName,
                         int saveFormat,
                         SplitOptions options)
                  throws java.lang.Exception

Throws:

java.lang.Exception

split

public static void split(java.lang.String inputFileName,
                         java.lang.String outputFileName,
                         SaveOptions saveOptions,
                         SplitOptions options)
                  throws java.lang.Exception

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:

inputFileName - The input file name.

outputFileName - The output file name used to generate file name for document parts using rule "outputFile_partIndex.extension"

saveOptions - The save options.

options - Document split options.

Throws:

java.lang.Exception

split

public static java.io.OutputStream[] split(java.io.InputStream inputStream,
                                           int saveFormat,
                                           SplitOptions options)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

split

public static java.io.OutputStream[] split(java.io.InputStream inputStream,
                                           SaveOptions saveOptions,
                                           SplitOptions options)
                                    throws java.lang.Exception

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:

inputStream - The input stream.

saveOptions - The save options.

options - Document split options.

Throws:

java.lang.Exception