com.groupdocs.redaction.integration

Class MetadataItem

java.lang.Object

com.groupdocs.redaction.integration.MetadataItem

public class MetadataItem
extends Object

Represents an item of metadata, common for all supported formats and used in metadata redactions.

Constructor Summary

Constructors

Constructor and Description
MetadataItem() Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
MetadataItem	createClone() Creates a deep clone of current instance.
String	getActualValue() Gets the string representation of the metadata item value.
String	getCategory() Gets a category of the metadata item, for example resource ID for an embedded resource metadata item.
String	getDictionaryKey() Gets a dictionary key for , using its OriginalName and other data.
int	getFilter() Gets a value of MetadataFilters, assigned to this metadata item which is used in item filtration.
String	getOriginalName() Gets an original name of the metadata item, as it appears in the document.
List<String>	getValues() Gets the metadata item value.
boolean	isCustom() Gets a value indicating whether this item is custom (added by the authors of the document).
void	setCategory(String value) Sets a category of the metadata item, for example resource ID for an embedded resource metadata item.
void	setCustom(boolean value) Sets a value indicating whether this item is custom (added by the authors of the document).
void	setFilter(int value) Sets a value of MetadataFilters, assigned to this metadata item which is used in item filtration.
void	setOriginalName(String value) Sets an original name of the metadata item, as it appears in the document.
void	setValues(List<String> value) Sets the metadata item value.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetadataItem

public MetadataItem()

Initializes a new instance.

Method Detail

createClone

public MetadataItem createClone()

Creates a deep clone of current instance.

Returns:

Object clone

getActualValue

public final String getActualValue()

Gets the string representation of the metadata item value.

Returns:

The string representation of the metadata item value.

getCategory

public final String getCategory()

Gets a category of the metadata item, for example resource ID for an embedded resource metadata item.

Returns:

A category of the metadata item, for example resource ID for an embedded resource metadata item.

getDictionaryKey

public String getDictionaryKey()

Gets a dictionary key for , using its OriginalName and other data.

Returns:

A dictionary key for , using its OriginalName and other data.

getFilter

public final int getFilter()

Gets a value of MetadataFilters, assigned to this metadata item which is used in item filtration.

Returns:

A value of MetadataFilters, assigned to this metadata item which is used in item filtration.

getOriginalName

public final String getOriginalName()

Gets an original name of the metadata item, as it appears in the document.

Returns:

An original name of the metadata item, as it appears in the document.

getValues

public final List<String> getValues()

Gets the metadata item value.

Returns:

The metadata item value.

isCustom

public final boolean isCustom()

Gets a value indicating whether this item is custom (added by the authors of the document).

Returns:

A value indicating whether this item is custom (added by the authors of the document).

setCategory

public final void setCategory(String value)

Sets a category of the metadata item, for example resource ID for an embedded resource metadata item.

Parameters:

value - A category of the metadata item, for example resource ID for an embedded resource metadata item.

setCustom

public final void setCustom(boolean value)

Sets a value indicating whether this item is custom (added by the authors of the document).

Parameters:

value - A value indicating whether this item is custom (added by the authors of the document).

setFilter

public final void setFilter(int value)

Sets a value of MetadataFilters, assigned to this metadata item which is used in item filtration.

Parameters:

value - A value of MetadataFilters, assigned to this metadata item which is used in item filtration.

setOriginalName

public final void setOriginalName(String value)

Sets an original name of the metadata item, as it appears in the document.

Parameters:

value - An original name of the metadata item, as it appears in the document.

setValues

public final void setValues(List<String> value)

Sets the metadata item value.

Parameters:

value - The metadata item value.