com.groupdocs.parser.data

Class AnnotationItem

java.lang.Object

com.groupdocs.parser.data.AnnotationItem

public final class AnnotationItem
extends Object

Represents an annotation item which is used in annotation extraction functionality.

Constructor Summary

Constructors

Constructor and Description
AnnotationItem(String value) Initializes a new instance of the AnnotationItem class.
AnnotationItem(String value, String annotationType) Initializes a new instance of the AnnotationItem class with the annotation type.

Method Summary

Modifier and Type	Method and Description
String	getAnnotationType() Gets the annotation type.
String	getAuthorInitials() Gets the annotation author initials.
String	getAuthorName() Gets the annotation author name.
Date	getTimestamp() Gets the date and time when the annotation was created or last modified.
String	getValue() Gets the value of the annotation item.
void	setAnnotationType(String annotationType) Sets the annotation type.
void	setAuthorInitials(String authorInitials) Sets the annotation author initials.
void	setAuthorName(String authorName) Sets the annotation author name.
void	setTimestamp(Date timestamp) Sets the date and time when the annotation was created or last modified.

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotationItem

public AnnotationItem(String value)

Initializes a new instance of the AnnotationItem class.

Parameters:

value - The value of the annotation item.

AnnotationItem

public AnnotationItem(String value,
                      String annotationType)

Initializes a new instance of the AnnotationItem class with the annotation type.

Parameters:

value - The value of the annotation item.

annotationType - The annotation type.

Method Detail

getValue

public String getValue()

Gets the value of the annotation item.

Returns:

A string value that represents the value of the annotation item.

getAnnotationType

public String getAnnotationType()

Gets the annotation type.

Returns:

The annotation type.

setAnnotationType

public void setAnnotationType(String annotationType)

Sets the annotation type.

Parameters:

annotationType - The annotation type.

getTimestamp

public Date getTimestamp()

Gets the date and time when the annotation was created or last modified.

Returns:

The date and time when the annotation was created or last modified; null if the document doesn't provide it.

setTimestamp

public void setTimestamp(Date timestamp)

Sets the date and time when the annotation was created or last modified.

Parameters:

timestamp - The date and time when the annotation was created or last modified.

getAuthorName

public String getAuthorName()

Gets the annotation author name.

Returns:

The annotation author name; null if the document doesn't provide it.

setAuthorName

public void setAuthorName(String authorName)

Sets the annotation author name.

Parameters:

authorName - The annotation author name.

getAuthorInitials

public String getAuthorInitials()

Gets the annotation author initials.

Returns:

The annotation author initials; null if the document doesn't provide it.

setAuthorInitials

public void setAuthorInitials(String authorInitials)

Sets the annotation author initials.

Parameters:

authorInitials - The annotation author initials.