MetadataItem

Inheritance: java.lang.Object

public class MetadataItem

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

Constructors

Constructor	Description
MetadataItem()	Initializes a new instance.

Methods

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

MetadataItem()

public MetadataItem()

Initializes a new instance.

getOriginalName()

public final String getOriginalName()

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

Returns: java.lang.String - An original name of the metadata item, as it appears in the document.

setOriginalName(String value)

public final void setOriginalName(String value)

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

Parameters:

Parameter	Type	Description
value	java.lang.String	An original name of the metadata item, as it appears in the document.

getCategory()

public final String getCategory()

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

Returns: java.lang.String - A category of the metadata item, for example resource ID for an embedded resource metadata item.

setCategory(String value)

public final void setCategory(String value)

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

Parameters:

Parameter	Type	Description
value	java.lang.String	A category of the metadata item, for example resource ID for an embedded resource metadata item.

getFilter()

public final int getFilter()

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

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

setFilter(int value)

public final void setFilter(int value)

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

Parameters:

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

getValues()

public final List<String> getValues()

Gets the metadata item value.

Returns: java.util.List<java.lang.String> - The metadata item value.

setValues(List value)

public final void setValues(List<String> value)

Sets the metadata item value.

Parameters:

Parameter	Type	Description
value	java.util.List<java.lang.String>	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: boolean - A value indicating whether this item is custom (added by the authors of the document).

setCustom(boolean value)

public final void setCustom(boolean value)

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

Parameters:

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

getDictionaryKey()

public String getDictionaryKey()

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

Returns: java.lang.String - A dictionary key for , using its OriginalName and other data.

createClone()

public MetadataItem createClone()

Creates a deep clone of current instance.

Returns: MetadataItem - Object clone

getActualValue()

public final String getActualValue()

Gets the string representation of the metadata item value.

Returns: java.lang.String - The string representation of the metadata item value.