public final class IptcDataSetCollection extends Metadata
Represents a collection of IPTC datasets.
Constructor and Description |
---|
IptcDataSetCollection()
Initializes a new instance of the
IptcDataSetCollection class. |
IptcDataSetCollection(IptcCollection collection)
Deprecated.
|
IptcDataSetCollection(IptcProperty[] properties)
Initializes a new instance of the
IptcDataSetCollection class. |
Modifier and Type | Method and Description |
---|---|
void |
addOrUpdate(IptcDataSet dataSet)
Adds or updates the specified dataset in the collection.
|
void |
addOrUpdate(IptcProperty property)
Adds or updates the specified property in the appropriate dataset.
|
void |
clear()
Removes all datasets from the collection.
|
IptcApplicationRecord |
getApplicationRecord()
Gets the Application Record dataset.
|
IptcEnvelopeRecord |
getEnvelopeRecord()
Gets the Envelope Record dataset.
|
IptcDataSet[] |
getItems()
Gets the items from the collection as an array.
|
IptcDataSet |
readByNumber(int number)
Gets the
IptcDataSet with the specified number. |
IptcProperty |
readProperty(int dataSetNumber,
int tagId)
Gets the
IptcProperty with the specified dataset number and tag identifier. |
void |
remove(int dataSetNumber)
Removes the dataset with the specified dataset number.
|
void |
remove(int dataSetNumber,
int tagId)
Removes the property with the specified dataset number and tag identifier.
|
void |
setApplicationRecord(IptcApplicationRecord value)
Sets the Application Record dataset.
|
void |
setEnvelopeRecord(IptcEnvelopeRecord value)
Sets the Envelope Record dataset.
|
IptcProperty[] |
toPropertyArray()
Returns an array containing all properties extracted from the IPTC package.
|
getByType, getKeys, getMetadataType, iterator, readByStringKey
public IptcDataSetCollection()
Initializes a new instance of the IptcDataSetCollection
class.
@Deprecated public IptcDataSetCollection(IptcCollection collection)
Initializes a new instance of the IptcDataSetCollection
class.
collection
- The collection.public IptcDataSetCollection(IptcProperty[] properties)
Initializes a new instance of the IptcDataSetCollection
class.
properties
- An array IptcProperty
.public final IptcDataSet[] getItems()
Gets the items from the collection as an array.
public final IptcEnvelopeRecord getEnvelopeRecord()
Gets the Envelope Record dataset.
public final void setEnvelopeRecord(IptcEnvelopeRecord value)
Sets the Envelope Record dataset.
value
- The Envelope Record dataset.public final IptcApplicationRecord getApplicationRecord()
Gets the Application Record dataset.
public final void setApplicationRecord(IptcApplicationRecord value)
Sets the Application Record dataset.
value
- The Application Record dataset.public final void addOrUpdate(IptcProperty property)
Adds or updates the specified property in the appropriate dataset.
property
- The IPTC property to add/update.ArgumentNullException
- The property could not be null.public final void addOrUpdate(IptcDataSet dataSet)
Adds or updates the specified dataset in the collection.
dataSet
- The IPTC dataset to add.ArgumentNullException
- The dataset could not be null.public final void remove(int dataSetNumber, int tagId)
Removes the property with the specified dataset number and tag identifier.
dataSetNumber
- The dataset number.tagId
- The tag identifier.public final void remove(int dataSetNumber)
Removes the dataset with the specified dataset number.
dataSetNumber
- The dataset number.public final void clear()
Removes all datasets from the collection.
public final IptcProperty[] toPropertyArray()
Returns an array containing all properties extracted from the IPTC package.
public final IptcDataSet readByNumber(int number)
Gets the IptcDataSet
with the specified number.
number
- The index.IptcDataSet
with the specified number, if found; otherwise null.public final IptcProperty readProperty(int dataSetNumber, int tagId)
Gets the IptcProperty
with the specified dataset number and tag identifier.
dataSetNumber
- The dataset number.tagId
- The tag identifier.IptcProperty
with the specified dataset number and tag identifier.Copyright © 2019. All rights reserved.