com.groupdocs.annotation

Class Annotator

java.lang.Object

com.groupdocs.annotation.Annotator

All Implemented Interfaces:

com.aspose.ms.System.IDisposable, Closeable, AutoCloseable

public class Annotator
extends Object
implements com.aspose.ms.System.IDisposable, Closeable

Represents main class that controls document annotating process.

Constructor Summary

Constructors

Constructor and Description
Annotator(InputStream inputStream) Initialise annotator class which accept document stream
Annotator(InputStream inputStream, AnnotatorSettings settings) Initialise annotator class which accept document stream
Annotator(InputStream inputStream, LoadOptions loadOptions) Initialise annotator class which accept document stream
Annotator(InputStream inputStream, LoadOptions loadOptions, AnnotatorSettings settings) Initialise annotator class which accept inputStream stream
Annotator(String filePath) Initialise annotator class which accept document path
Annotator(String filePath, AnnotatorSettings settings) Initialise annotator class which accept document path
Annotator(String filePath, LoadOptions loadOptions) Initialise annotator class which accept document path
Annotator(String filePath, LoadOptions loadOptions, AnnotatorSettings settings) Initialise annotator class which accept document path

Method Summary

Modifier and Type	Method and Description
void	add(AnnotationBase annotation) Adds annotation to document
void	add(List<AnnotationBase> annotations) Adds collection of annotations to a document.
void	close()
void	dispose() Dispose
void	exportAnnotationsFromDocument(String filePath) Export annotations from XML document.
List<AnnotationBase>	get() Gets collections of document annotations.
List<AnnotationBase>	get(int type) Gets collection of document annotations by annotation type.
Document	getDocument() Document
int	getProcessPages() Document pages
Byte	getRotation() Document Rotation
List<AnnotationBase>	getVersion(Object version) Get annotations from versions.
List<Object>	getVersionsList() Get versions.
void	importAnnotationsFromDocument(String outputPath) Import annotations from document to XML file.
void	remove(AnnotationBase... annotationsToDelete) Removes collection of annotations from document by provided annotation ids.
void	remove(AnnotationBase annotation) Removes annotation from document.
void	remove(int annotationId) Removes annotation from document by Id.
void	remove(List<Integer> annotationsIdsToDelete) Removes collection of annotations from document by provided annotation ids.
void	removeInternal(List<AnnotationBase> annotationsToDelete) Removes collection of annotations from document.
void	save() Saves document after adding, updating or removing annotations.
void	save(OutputStream document) Saves document after adding, updating or removing annotations.
void	save(OutputStream outputStream, SaveOptions saveOptions) Saves outputStream after adding, updating or removing annotations.
void	save(SaveOptions saveOptions) Saves document after adding, updating or removing annotations.
void	save(String filePath) Saves document after adding, updating or removing annotations.
void	save(String filePath, SaveOptions saveOptions) Saves document after adding, updating or removing annotations.
void	setProcessPages(int value) Document pages
void	setRotation(Byte value) Document Rotation
void	update(AnnotationBase newAnnotation) Updates document annotation.
void	update(List<AnnotationBase> annotations) Updates collection of document annotations.

Methods inherited from class java.lang.Object

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

Constructor Detail

Annotator

public Annotator(InputStream inputStream)

Initialise annotator class which accept document stream

Parameters:

inputStream - Document stream

<b>Learn more</b>

Annotator

public Annotator(InputStream inputStream,
                 AnnotatorSettings settings)

Initialise annotator class which accept document stream

Parameters:

inputStream - Document stream

settings - Annotator settings

<b>Learn more</b>

Annotator

public Annotator(InputStream inputStream,
                 LoadOptions loadOptions)

Initialise annotator class which accept document stream

Parameters:

inputStream - Document stream

loadOptions - Load options

<b>Learn more</b>

Annotator

public Annotator(InputStream inputStream,
                 LoadOptions loadOptions,
                 AnnotatorSettings settings)

Initialise annotator class which accept inputStream stream

Parameters:

inputStream - Document stream

loadOptions - Load options

settings - Annotator settings

<b>Learn more</b>

Annotator

public Annotator(String filePath)

Initialise annotator class which accept document path

Parameters:

filePath - File path

<b>Learn more</b>

Annotator

public Annotator(String filePath,
                 AnnotatorSettings settings)

Initialise annotator class which accept document path

Parameters:

filePath - File path

settings - Annotator settings

<b>Learn more</b>

Annotator

public Annotator(String filePath,
                 LoadOptions loadOptions)

Initialise annotator class which accept document path

Parameters:

filePath - File path

loadOptions - Load options

<b>Learn more</b>

Annotator

public Annotator(String filePath,
                 LoadOptions loadOptions,
                 AnnotatorSettings settings)

Initialise annotator class which accept document path

Parameters:

filePath - File path

loadOptions - Load options

settings - Annotator settings

<b>Learn more</b>

Method Detail

add

public final void add(AnnotationBase annotation)

Adds annotation to document

Parameters:

annotation - The annotation to add.

<b>Learn more</b>

add

public final void add(List<AnnotationBase> annotations)

Adds collection of annotations to a document.

Parameters:

annotations - The annotations list to add.

<b>Learn more</b>

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

dispose

public final void dispose()

Dispose

Specified by:

dispose in interface com.aspose.ms.System.IDisposable

exportAnnotationsFromDocument

public final void exportAnnotationsFromDocument(String filePath)

Export annotations from XML document.

Parameters:

filePath - The input file path.

<b>Learn more</b>

get

public final List<AnnotationBase> get()

Gets collections of document annotations.

Returns:

The list of annotations.

<b>Learn more</b>

get

public final List<AnnotationBase> get(int type)

Gets collection of document annotations by annotation type.

Parameters:

type - The annotations type that must be returned.

<b>Learn more</b>

Returns:

The list of annotations by type.

getDocument

public final Document getDocument()

Document

Returns:

getProcessPages

public final int getProcessPages()

Document pages

Returns:

getRotation

public final Byte getRotation()

Document Rotation

Returns:

getVersion

public final List<AnnotationBase> getVersion(Object version)

Get annotations from versions.

Parameters:

version - The version's Key of versions which you want to return

Returns:

The list of annotations from specific versions. If null will return last.

getVersionsList

public final List<Object> getVersionsList()

Get versions.

Returns:

The list of versions.

importAnnotationsFromDocument

public final void importAnnotationsFromDocument(String outputPath)

Import annotations from document to XML file.

Parameters:

outputPath - The output file path.

<b>Learn more</b>

remove

public final void remove(AnnotationBase... annotationsToDelete)

Removes collection of annotations from document by provided annotation ids.

Parameters:

annotationsToDelete - The annotation's id that must be removed.

<b>Learn more</b>

remove

public final void remove(AnnotationBase annotation)

Removes annotation from document.

Parameters:

annotation - Annotation that must be removed.

<b>Learn more</b>

remove

public final void remove(int annotationId)

Removes annotation from document by Id.

Parameters:

annotationId - The annotation's id that must be removed.

<b>Learn more</b>

remove

public final void remove(List<Integer> annotationsIdsToDelete)

Removes collection of annotations from document by provided annotation ids.

Parameters:

annotationsIdsToDelete - The annotation's id that must be removed.

<b>Learn more</b>

removeInternal

public final void removeInternal(List<AnnotationBase> annotationsToDelete)

Removes collection of annotations from document.

Parameters:

annotationsToDelete - The annotations that must be removed.

<b>Learn more</b>

save

public final void save()

Saves document after adding, updating or removing annotations.

<b>Learn more about saving annotated documents</b>

save

public final void save(OutputStream document)

Saves document after adding, updating or removing annotations.

Parameters:

document - The output stream.

<b>Learn more about saving annotated documents</b>

save

public final void save(OutputStream outputStream,
                       SaveOptions saveOptions)

Saves outputStream after adding, updating or removing annotations.

Parameters:

outputStream - The output stream.

saveOptions - The save options.

<b>Learn more about saving annotated documents</b>

save

public final void save(SaveOptions saveOptions)

Saves document after adding, updating or removing annotations.

Parameters:

saveOptions - The save options.

<b>Learn more about saving annotated documents</b>

save

public final void save(String filePath)

Saves document after adding, updating or removing annotations.

Parameters:

filePath - The output file path.

<b>Learn more about saving annotated documents</b>

save

public final void save(String filePath,
                       SaveOptions saveOptions)

Saves document after adding, updating or removing annotations.

Parameters:

filePath - The output file path.

saveOptions - The save options.

<b>Learn more about saving annotated documents</b>

setProcessPages

public final void setProcessPages(int value)

Document pages

Parameters:

value -

setRotation

public final void setRotation(Byte value)

Document Rotation

Parameters:

value -

update

public final void update(AnnotationBase newAnnotation)

Updates document annotation.

Parameters:

newAnnotation - The annotation to update (Id should be provided).

<b>Learn more</b>

update

public final void update(List<AnnotationBase> annotations)

Updates collection of document annotations.

Parameters:

annotations - The annotations list that will be set.

<b>Learn more</b>