com.groupdocs.metadata

Interfaces

Classes

Exceptions

com.groupdocs.metadata

Class IptcDataSetCollection

    • Constructor Detail

      • IptcDataSetCollection

        public IptcDataSetCollection()

        Initializes a new instance of the IptcDataSetCollection class.

      • IptcDataSetCollection

        @Deprecated
        public IptcDataSetCollection(IptcCollection collection)
        Deprecated. 

        Initializes a new instance of the IptcDataSetCollection class.

        Parameters:
        collection - The collection.
      • IptcDataSetCollection

        public IptcDataSetCollection(IptcProperty[] properties)

        Initializes a new instance of the IptcDataSetCollection class.

        Parameters:
        properties - An array IptcProperty.
    • Method Detail

      • getItems

        public final IptcDataSet[] getItems()

        Gets the items from the collection as an array.

        Returns:
        The items from the collection as an array.
      • getEnvelopeRecord

        public final IptcEnvelopeRecord getEnvelopeRecord()

        Gets the Envelope Record dataset.

        Returns:
        The Envelope Record dataset.
      • setEnvelopeRecord

        public final void setEnvelopeRecord(IptcEnvelopeRecord value)

        Sets the Envelope Record dataset.

        Parameters:
        value - The Envelope Record dataset.
      • getApplicationRecord

        public final IptcApplicationRecord getApplicationRecord()

        Gets the Application Record dataset.

        Returns:
        The Application Record dataset.
      • setApplicationRecord

        public final void setApplicationRecord(IptcApplicationRecord value)

        Sets the Application Record dataset.

        Parameters:
        value - The Application Record dataset.
      • addOrUpdate

        public final void addOrUpdate(IptcProperty property)

        Adds or updates the specified property in the appropriate dataset.

        Parameters:
        property - The IPTC property to add/update.
        Throws:
        ArgumentNullException - The property could not be null.
      • addOrUpdate

        public final void addOrUpdate(IptcDataSet dataSet)

        Adds or updates the specified dataset in the collection.

        Parameters:
        dataSet - The IPTC dataset to add.
        Throws:
        ArgumentNullException - The dataset could not be null.
      • remove

        public final void remove(int dataSetNumber,
                  int tagId)

        Removes the property with the specified dataset number and tag identifier.

        Parameters:
        dataSetNumber - The dataset number.
        tagId - The tag identifier.
      • remove

        public final void remove(int dataSetNumber)

        Removes the dataset with the specified dataset number.

        Parameters:
        dataSetNumber - The dataset number.
      • clear

        public final void clear()

        Removes all datasets from the collection.

      • toPropertyArray

        public final IptcProperty[] toPropertyArray()

        Returns an array containing all properties extracted from the IPTC package.

        Returns:
        An array containing all properties extracted from the IPTC package.
      • readByNumber

        public final IptcDataSet readByNumber(int number)

        Gets the IptcDataSet with the specified number.

        Parameters:
        number - The index.
        Returns:
        The IptcDataSet with the specified number, if found; otherwise null.
      • readProperty

        public final IptcProperty readProperty(int dataSetNumber,
                                int tagId)

        Gets the IptcProperty with the specified dataset number and tag identifier.

        Parameters:
        dataSetNumber - The dataset number.
        tagId - The tag identifier.
        Returns:
        The IptcProperty with the specified dataset number and tag identifier.