ImageGear for Java
ImGearIPTCMetadata Class Members
| ImageGearJava Project > com.accusoft.imagegear.formats.iptc Package : ImGearIPTCMetadata Class |
The following tables list the members exposed by ImGearIPTCMetadata.
| Name | Description | |
|---|---|---|
 | ImGearIPTCMetadata Constructor | Initializes a new instance of the ImGearIPTCMetadata class. |
| Name | Description | |
|---|---|---|
 | getActionAdvised | Returns Action Advised IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Action Advised IPTC DataSet (2:42). The dataset indicates the type of action that this object provides to a previous object. |
| getARMIdentifier | Returns ARM Identifier IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the ARM Identifier IPTC DataSet (1:120). The DataSet identifies the Abstract Relationship method (ARM), which is described in a document registered by the originator of the ARM with the IPTC and NAA. |
| getARMVersion | Returns ARM Version IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the ARM Version IPTC DataSet (1:122). The DataSet represents the particular version of the ARM specified in DataSet 1:120. |
| getAudioDuration | Returns Audio Duration IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Audio Duration IPTC DataSet (2:153). The DataSet designates in the form HHMMSS the running time of an audio object data when played back at the speed at which it was recorded. Contains six bytes, consisting of numeric characters. |
| getAudioOutcue | Returns Audio Outcue IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Audio Outcue IPTC DataSet (2:154). The DataSet identifies the content of the end of an audio objectdata, according to guidelines established by the provider. Maximum 64 bytes, consisting of graphic characters plus spaces. |
| getAudioSamplingRate | Returns Audio Sampling Rate IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Audio Sampling Rate DataSet (2:151). The DataSet represents the sampling rate in hertz (Hz). Six bytes with leading zero(s), consisting of numeric characters. |
| getAudioSamplingResolution | Returns Audio Sampling Resolution IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Audio Sampling Resolution DataSet (2:152). The DataSet represents the number of bits in each audio sample. Contains two bytes with leading zero(s), consisting of numeric characters. |
| getAudioType | Returns Audio Type IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Audio Type DataSet (2:150). The DataSet represents the number of audio channels and the exact type of audio contained in the current objectdata. |
| getBitsPerComponent | Returns Bits Per Component IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Bits Per Component DataSet (3:135). The DataSet contains a sequence of one or more bytes describing the number of bits used to encode each component. The sequence is specified by the order of components in DataSet 3:65. |
| getByLine | Returns By Line IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the By-line DataSet (2:80). The DataSet contains the name of the creator of the objectdata, e.g., writer, photographer, or graphic artist. Repeatable (array items represent repeated values), maximum 32 bytes, consisting of graphic characters plus spaces. |
| getByLineTitle | Returns By Line Title IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the By-line Title DataSet (2:85). The DataSet specifies the title of the creator or creators of an objectdata. Repeatable (array items represent repeated values), maximum 32 bytes, consisting of graphic characters plus spaces. |
| getCaption_Abstract | Returns Caption/Abstract IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Caption/Abstract DataSet (2:120). The DataSet contains a textual description of the objectdata, particularly used where the object is not text. Maximum of 2000 bytes, consisting of graphic characters plus carriage-returns, linefeeds, and spaces. |
| getCategory | Returns Category IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Category DataSet (2:15). The DataSet identifies the subject of the objectdata in the opinion of the provider. Maximum three bytes, consisting of alphabetic characters. |
| getCity | Returns City IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the City DataSet (2:90). The DataSet identifies the city of objectdata origin according to guidelines established by the provider. Maximum 32 bytes, consisting of graphic characters plus spaces. |
| getCodedCharacterSet | Returns Coded Character Set IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Coded Character Set DataSet (1:90). The DataSet consists of one or more control functions used for the announcement, invocation, or designation of coded character sets. The control functions follow the ISO 2022 standard and may consist of the escape control character and one or more graphic characters. Contains up to 32 bytes. |
| getColourCalibrationMatrixTable | Returns Colour Calibration Matrix Table IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Colour Calibration Matrix Table DataSet (3:70). The DataSet is no longer required as its contents have been rendered obsolete by the introduction of DataSet P3:66 (ICC Input Colour Profile). |
| getColourPalette | Returns Colour Palette IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Colour Palette DataSet (3:85). The purpose of the Colour Palette is to act as a lookup table mapping the pixel values into the Colour Space defined in Interchange Colour Space DataSet (3:64). Contains up to 524,288 (4 x 65536 x 2) bytes. A number of default palettes may be held to be selected according to the device identifier component of the Picture Number 3:10. |
| getColourRepresentation | Returns Colour Representation IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Colour Representation DataSet (3:60). The DataSet specifies the number of image components and the build-up structure of the image. |
| getColourSequence | Returns Colour Sequence IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Colour Sequence DataSet (3:65). The DataSet specifies the sequence of the components as they appear in the objectdata. |
| getConfirmedObjectDataSize | Returns Confirmed Object Data Size IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the ConfirmedObjectDataSize DataSet (9:10). The DataSet specifies total size of the objectdata, in bytes, without tags. |
| getContact | Returns Contact IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Contact DataSet (2:118). The DataSet identifies the person or organization that can provide further background information on the objectdata. Repeatable (array items represent repeated values), maximum of 128 bytes, consisting of graphic characters plus spaces. |
| getContentLocationCode | Returns Content Location Code IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the ContentLocationCode DataSet (2:26). The DataSet indicates the code of a country/geographical location referenced by the content of the object. Repeatable (array items represent repeated values), 3 bytes consisting of alphabetic characters. |
| getContentLocationName | Returns Content Location Name IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the ContentLocationName DataSet (2:27). The DataSet provides a full, publishable name of a country/geographical location referenced by the content of the object, according to guidelines of the provider. Repeatable (array items represent repeated values), maximum 64 bytes, consisting of graphic characters plus spaces. |
| getCopyrightNotice | Returns Copyright Notice IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the CopyrightNotice DataSet (2:116). The DataSet contains any necessary copyright notice. Contains maximum of 128 bytes, consisting of graphic characters plus spaces. |
| getCountryPrimaryLocationCode | Returns Country Primary Location Code IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Country/PrimaryLocationCode DataSet (2:100). The DataSet indicates the code of the country/primary location where the intellectual property of the objectdata was created, e.g., a photo was taken, an event occured. Contains three bytes consisting of alphabetic characters. |
| getCountryPrimaryLocationName | Returns Country Primary Location Name IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Country/PrimaryLocationName DataSet (2:101). The DataSet provides the full, publishable name of the country/primary location where the intellectual property of the objectdata was created, according to guidelines of the provider. Contains maximum 64 bytes, consisting of graphic characters plus spaces. |
| getCredit | Returns Credit IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Credit DataSet (2:110). The DataSet identifies the provider of the objectdata, not necessarily the owner/creator. Contains maximum of 32 bytes, consisting of graphic characters plus spaces. |
| getDataCompressionMethod | Returns Data Compression method IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Data Compression method DataSet (3:110). The DataSet specifies the provider/owner, type, and version of the compression algorithm. |
| getDateCreated | Returns Date Created IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the DateCreated DataSet (2:55). The DataSet represented in the form CCYYMMDD to designate the date the intellectual content of the objectdata was created rather than the date of the creation of the physical representation. Contains eight bytes, consisting of numeric characters. |
| getDateSent | Returns Date Sent IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Date Sent DataSet (1:70). The DataSet uses the format CCYYMMDD (century, year, month, day) as defined in ISO 8601 to indicate year, month, and day the service sent the material. Contains eight bytes, consisting of numeric characters. |
| getDestination | Returns Destination IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Destination DataSet (1:05). The DataSet is to accommodate some providers who require routing information above the appropriate OSI layers. Repeatable (array items represent repeated values), maximum 1024 bytes, consisting of sequentially contiguous graphic characters. |
| getDigitalCreationDate | Returns Digital Creation Date IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the DigitalCreationDate DataSet (2:62). The DataSet represented in the form CCYYMMDD to designate the date the digital representation of the objectdata was created. Contains eight bytes, consisting of numeric characters. |
| getDigitalCreationTime | Returns Digital Creation Time IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the DigitalCreationTime DataSet (2:63). The DataSet is represented in the form HHMMSS-HHMM to designate the time the digital representation of the objectdata was created. Follows ISO 8601 standard. Contains 11 bytes, consisting of graphic characters. |
| getEditorialUpdate | Returns Editorial Update IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the EditorialUpdate DataSet (2:08). The DataSet indicates the type of update that this object provides to a previous object. Contains 2 bytes, consisting of numeric characters. |
| getEditStatus | Returns Edit Status IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Edit Status DataSet (2:07). The DataSet specifies the status of the objectdata, according to the practice of the provider. Maximum 64 bytes, consisting of graphic characters plus spaces. |
| getEndPoints | Returns End Points IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the EndPoints DataSet (3:125). The DataSet contains the values representing minimum and maximum density for each component. |
| getEnvelopeNumber | Returns Envelope Number IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the EnvelopeNumber DataSet (1:40). Characters of the DataSet form a number that will be unique for the date specified in 1:70 and for the Service Identifier specified in 1:30. Contains eight bytes, consisting of numeric characters. |
| getEnvelopePriority | Returns Envelope Priority IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the EnvelopePriority DataSet (1:60). The DataSet specifies the envelope handling priority and not the editorial urgency (see 2:10, Urgency). '1' indicates the most urgent, '5' the normal urgency, and '8' the least urgent copy. The numeral '9' indicates a User Defined Priority. The numeral '0' is reserved for future use. Contains a single byte, consisting of a numeric character. |
| getExcursionTolerance | Returns Excursion Tolerance IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the ExcursionTolerance DataSet (3:130). The DataSet indicates if values outside the range defined by the end points in DataSet 3:125 may occur. |
| getExpirationDate | Returns Expiration Date IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the ExpirationDate DataSet (2:37). The DataSet designates in the form CCYYMMDD the latest date the provider or owner intends the objectdata to be used. Contains eight bytes, consisting of numeric characters. |
| getExpirationTime | Returns Expiration Time IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the ExpirationTime DataSet (2:38). The DataSet designates in the form HHMMSS-HHMM the latest time the provider or owner intends the objectdata to be used. Contains 11 bytes, consisting of graphic characters. |
| getFileFormat | Returns File Format IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the File Format DataSet (1:20). The DataSet represents the file format. The file format must be registered with IPTC or NAA with a unique number. The information is used to route the data to the appropriate system and to allow the receiving system to perform the appropriate actions thereto. |
| getFileFormatVersion | Returns File Format Version IPTC dataset. This method accesses the File Format Version DataSet (1:22). The DataSet contains a binary number representing the particular version of the File Format specified in 1:20. Method returns the tag value if the tag is present in the metadata tree, or null otherwise.
See the IPTC - NAA Information Interchange Model ver. 4.1 specification for tag usage details. |
| getFixtureIdentifier | Returns Fixture Identifier IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Fixture Identifier DataSet (2:22). The DataSet identifies objectdata that recurs often and predictably. Enables users to immediately find or recall such an object. Contains maximum 32 bytes, consisting of graphic characters. |
| getGammaCompensatedValue | Returns Gamma Compensated Value IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the GammaCompensatedValue DataSet (3:145). The DataSet specifies the value of gamma for the device multiplied by 100. If this DataSet is omitted, receiving equipment should assume that a gamma value of 2.22 applies. |
| getHeadline | Returns Headline IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Headline DataSet (2:105). The DataSet contains a publishable entry providing a synopsis of the contents of the objectdata. Contains maximum of 256 bytes, consisting of graphic characters plus spaces. |
| getICCInputColourProfile | Returns ICC Input Colour Profile IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the ICC InputColourProfile DataSet (3:66). The DataSet specifies the International Color Consortium profile for the scanning/source device used to generate the digital image files. |
| getImageOrientation | Returns Image Orientation IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the ImageOrientation DataSet (2:131). The DataSet indicates the layout of the image area. |
| getImageRotation | Returns Image Rotation IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the ImageRotation DataSet (3:102). The DataSet indicates the clockwise rotation applied to the image for presentation. |
| getImageType | Returns Image Type IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Image Type DataSet (2:130). The DataSet specifies whether the objectdata contains an image or a supplemental object, number of channels in the image and exact content of the objectdata in terms of colour composition. |
| getInterchangeColourSpace | Returns Interchange Colour Space IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the InterchangeColourSpace DataSet (3:64). The DataSet indicates the colour space in which the pixel values are expressed for each component in the image. |
| getKeywords | Returns Keywords IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Keywords DataSet (2:25). The DataSet indicates specific information retrieval words. Repeatable (array items represent repeated values), maximum 64 bytes, consisting of graphic characters plus spaces. |
| getLanguageIdentifier | Returns Language Identifier IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Language Identifier DataSet (2:135). The DataSet describes the major national language of the object, according to the 2-letter codes of ISO 639:1988. Contains two or three bytes, consisting of alphabetic characters. |
| getLookupTable | Returns Lookup Table IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the LookupTable DataSet (3:80). The DataSet consists of one, three or four one-dimensional lookup tables (LUT).The LUT relates to the image data in the colour space defined in DataSet 3:64 and specifies the correction to apply to the pixel values before display or printing of the image. |
| getMaximumDensityRange | Returns Maximum Density Range IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the MaximumDensityRange DataSet (3:140). The DataSet represents the difference between the lowest density and the highest density points that can be encoded by the originating system. |
| getMaximumObjectDataSize | Returns Maximum Object Data Size IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the MaximumObjectDataSize DataSet (7:95). When objectdata size is not known, the DataSet indicates the largest size, expressed in bytes, that the objectdata can possibly have, not including tags. |
| getMaxSubfileSize | Returns Max Subfile Size IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Max SubfileSize DataSet (7:20). The DataSet indicates the maximum size for the following Subfile DataSet(s). |
| getModelVersion | Returns Model Version IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Model Version DataSet (1:00). The DataSet identifies the version of the Information Interchange Model, Part I, utilized by the provider. |
| getNumberOfBitsPerSample | Returns Number Of Bits Per Sample IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Number of Bits per Sample DataSet (3:86). The DataSet indicates the number of bits per pixel value used as entries in the Colour Palette. |
| getNumberOfIndexEntries | Returns Number Of Index Entries IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Number of Index Entries DataSet (3:84). The DataSet represents the number of index entries in the DataSet 3:85 (Colour Palette). |
| getNumberOfLines | Returns Number Of Line IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Number of Lines DataSet (3:30). The DataSet represents the number of scan lines comprising the image for the component with the highest resolution. |
| getObjectAttributeReference | Returns Object Attribute Reference IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the ObjectAttributeReference DataSet (2:04). The DataSet defines the nature of the object independent of the Subject. Repeatable (array items represent repeated values). |
| getObjectCycle | Returns Object Cycle IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Object Cycle DataSet (2:75). The DataSet represents object cycle, virtually only used in North America. |
| getObjectDataPreviewData | Returns Object Data Preview Data IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the ObjectData Preview Data DataSet (2:202). Maximum size: 256000 bytes. |
| getObjectDataPreviewFileFormat | Returns ObjectData Preview File Format DataSet (2:200).
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the ObjectData Preview File Format DataSet (2:200). The DataSet represents the file format of the ObjectData Preview. |
| getObjectDataPreviewFileFormatVersion | Returns Object Data Preview File Format Version IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the ObjectData Preview File Format Version DataSet (2:201). The DataSet represents the particular version of the ObjectData Preview File Format specified in 2:200. |
| getObjectDataSizeAnnounced | Returns Object Data Size Announced IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the ObjectData Size Announced DataSet (7:90). The DataSet represents the overall size of the objectdata, expressed in bytes, not including tags, if that size is known when transfer commences. |
| getObjectName | Returns Object Name IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Object Name DataSet (2:05). The DataSet used as a shorthand reference for the object. Maximum 64 bytes, consisting of graphic characters plus spaces. |
| getObjectTypeReference | Returns Object Type Reference IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Object Type Reference DataSet (2:03). The DataSet is used to distinguish between different types of objects within the IIM. |
| getOriginalTransmissionReference | Returns Original Transmission Reference IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Original Transmission Reference DataSet (2:103). The DataSet represents the location of original transmission according to practices of the provider. Maximum 32 bytes, consisting of graphic characters plus spaces. |
| getOriginatingProgram | Returns Originating Program IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Originating Program DataSet (2:65). The DataSet identifies the type of program used to originate the objectdata. Maximum of 32 bytes, consisting of graphic characters plus spaces. |
| getPictureNumber | Returns Picture Number IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Picture Number DataSet (3:10). The DataSet provides a universally unique reference to an image. |
| getPixelSizeInScanningDirection | Returns Pixel Size In Scanning Direction IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Pixel Size In Scanning Direction DataSet (3:40). The DataSet indicates the number of pixels per unit length in the scanning direction. |
| getPixelSizePerpendicularToScanningDirection | Returns Pixel Size Perpendicular To Scanning Direction IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Pixel Size Perpendicular To Scanning Direction DataSet (3:50). The DataSet indicates the number of pixels per unit length perpendicular to the scanning direction. |
| getPixelsPerLine | Returns Pixels Per Line IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Pixels Per Line DataSet (3:20). The DataSet represents the number of pixels in a scan line for the component with the highest resolution. |
| getProductID | Returns ProductID IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Product I.D. DataSet (1:50). The DataSet allows a provider to identify subsets of its overall service. Used to provide receiving organization data on which to select, route, or otherwise handle data. Repeatable (array items represent repeated values). Up to 32 bytes, consisting of graphic characters. |
| getProgramVersion | Returns Program Version IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Program Version DataSet (2:70). The DataSet identifies the version of the program mentioned in Originating Program DataSet (2:65). Invalid if 2:65 is not present. Maximum of 10 bytes, consisting of graphic characters plus spaces. |
| getProvinceState | Returns Province State IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Province/State DataSet (2:95). The DataSet identifies Province/State of origin according to guidelines established by the provider. Maximum 32 bytes, consisting of graphic characters plus spaces. |
| getQuantisationMethod | Returns Quantisation method IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Quantisation method DataSet (3:120). The DataSet identifies the quantisation law. The relations between different quantisation methods are described in DNPR Guideline 1. |
| getRasterizedCaption | Returns Rasterized Caption IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Rasterized Caption DataSet (2:125). The DataSet contains the rasterized objectdata description and is used where characters that have not been coded are required for the caption. Contains 7360 bytes, consisting of binary data, one bit per pixel, two value bitmap where 1 (one) represents black and 0 (zero) represents white. Image width 460 pixels and image height 128 pixels. Scanning direction bottom to top, left to right. |
| getRecord2Version | Returns Record2 Version IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Record II Version DataSet (2:00). The DataSet identifies the version of the Information Interchange Model, Part II (Record 2:xx), utilised by the provider. Version numbers are assigned by IPTC and NAA. |
| getRecord3Version | Returns Record3 Version IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Record Version DataSet (3:00). The DataSet represents the version of the Digital Newsphoto Parameter Record utilized by the provider. Version numbers are assigned by IPTC and NAA. |
| getReferenceDate | Returns Reference Date IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Reference Date DataSet (2:47). The DataSet identifies the date of a prior envelope to which the current object refers. Repeatable (array items represent repeated values). Uses the format CCYYMMDD (century, year, month, day) as defined in ISO 8601 to indicate year, month and day. |
| getReferenceNumber | Returns Reference Number IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Reference Number DataSet (2:50). The DataSet identifies the Envelope Number of a prior envelope to which the current object refers. Repeatable (array items represent repeated values), eight bytes, consisting of numeric characters. |
| getReferenceService | Returns Reference Service IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Reference Service DataSet (2:45). The DataSet identifies the Service Identifier of a prior envelope to which the current object refers. Repeatable (array items represent repeated values), up to 10 bytes, consisting of graphic characters. |
| getReleaseDate | Returns Release Date IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Release Date DataSet (2:30). The DataSet designates in the form CCYYMMDD the earliest date the provider intends the object to be used. Follows ISO 8601 standard. Eight bytes, consisting of numeric characters. |
| getReleaseTime | Returns Release Time IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Release Time DataSet (2:35). The DataSet designates in the form HHMMSS-HHMM the earliest time the provider intends the object to be used. Follows ISO 8601 standard. Contains 11 bytes, consisting of graphic characters. |
| getSamplingStructure | Returns Sampling structure IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Sampling structure DataSet (3:90). The DataSet defines the spatial and temporal relationship between pixels. |
| getScanningDirection | Returns Scanning Direction IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Scanning Direction DataSet (3:100). The DataSet indicates the correct relative two dimensional order of the pixels in the objectdata. |
| getServiceIdentifier | Returns Service Identifier IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Service Identifier DataSet (1:30). The DataSet identifies the provider and product. Contains up to 10 bytes, consisting of graphic characters. |
| getSizeMode | Returns Size Mode IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Size Mode DataSet (7:10). The DataSet indicates whether the size of the objectdata is known at the beginning of transfer. |
| getSource | Returns Source IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Source DataSet (2:115). The DataSet identifies the original owner of the intellectual content of the objectdata. This could be an agency, a member of an agency or an individual. Maximum of 32 bytes, consisting of graphic characters plus spaces. |
| getSpecialInstructions | Returns Special Instructions IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Special Instructions DataSet (2:40). The DataSet contains other editorial instructions concerning the use of the objectdata, such as embargoes and warnings. Maximum 256 bytes, consisting of graphic characters plus spaces. |
| getSubjectReference | Returns Subject Reference IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Subject Reference DataSet (2:12). The DataSet represents a structured definition of the subject matter. Repeatable (array items represent repeated values). |
| getSublocation | Returns Sublocation IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Sublocation DataSet (2:92). The DataSet identifies the location within a city from which the objectdata originates, according to guidelines established by the provider. Maximum 32 bytes, consisting of graphic characters plus spaces. |
| getSupplementalCategory | Returns Supplemental Category IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Supplemental Category DataSet (2:20). The DataSet further refines the subject of an objectdata. Repeatable (array items represent repeated values), maximum 32 bytes, consisting of graphic characters plus spaces. |
| getSupplementType | Returns Supplement Type IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Supplement Type. DataSet (3:55). The DataSet indicates the image content. |
| getTimeCreated | Returns Time Created IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Time Created DataSet (2:60). The DataSet designates the time the intellectual content of the objectdata current source material was created rather than the creation of the physical representation. Contains 11 bytes, consisting of graphic characters. Represented in the form HHMMSS-HHMM. Follows ISO 8601 standard. |
| getTimeSent | Returns Time Sent IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Time Sent DataSet (1:80). The DataSet indicates the time the service sent the material. Contains 11 bytes, consisting of graphic characters. Uses the format HHMMSS-HHMM where HHMMSS refers to local hour, minute, and seconds and HHMM refers to hours and minutes ahead (+) or behind (-) Universal Coordinated Time as described in ISO 8601. |
| getUNO | Returns UNO IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the UNO DataSet (1:100). The UNO (Unique Name of Object) DataSet provides eternal, globally unique identification for objects as specified in the IIM, independent of provider and for any media form. The provider must ensure the UNO is unique. Objects with the same UNO are identical. |
| getUrgency | Returns Urgency IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Urgency DataSet (2:10). The DataSet Specifies the editorial urgency of content and not necessarily the envelope handling priority. |
| getWriter_Editor | Returns Writer/Editor IPTC dataset.
Method returnsthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Writer/Editor DataSet (2:122). The DataSet contains identification of the name of the person involved in the writing, editing, or correcting the objectdata or caption/abstract. Repeatable (array items represent repeated values), maximum 32 bytes, consisting of graphic characters plus spaces. |
| setActionAdvised | Sets Action Advised IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Action Advised IPTC DataSet (2:42). The dataset indicates the type of action that this object provides to a previous object. |
| setARMIdentifier | Sets ARM Identifier IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the ARM Identifier IPTC DataSet (1:120). The DataSet identifies the Abstract Relationship method (ARM), which is described in a document registered by the originator of the ARM with the IPTC and NAA. |
| setARMVersion | Sets ARM Version IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the ARM Version IPTC DataSet (1:122). The DataSet represents the particular version of the ARM specified in DataSet 1:120. |
| setAudioDuration | Sets Audio Duration IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Audio Duration IPTC DataSet (2:153). The DataSet designates in the form HHMMSS the running time of an audio object data when played back at the speed at which it was recorded. Contains six bytes, consisting of numeric characters. |
| setAudioOutcue | Sets Audio Outcue IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Audio Outcue IPTC DataSet (2:154). The DataSet identifies the content of the end of an audio objectdata, according to guidelines established by the provider. Maximum 64 bytes, consisting of graphic characters plus spaces. |
| setAudioSamplingRate | Sets Audio Sampling Rate IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Audio Sampling Rate DataSet (2:151). The DataSet represents the sampling rate in hertz (Hz). Six bytes with leading zero(s), consisting of numeric characters. |
| setAudioSamplingResolution | Sets Audio Sampling Resolution IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Audio Sampling Resolution DataSet (2:152). The DataSet represents the number of bits in each audio sample. Contains two bytes with leading zero(s), consisting of numeric characters. |
| setAudioType | Sets Audio Type IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Audio Type DataSet (2:150). The DataSet represents the number of audio channels and the exact type of audio contained in the current objectdata. |
| setBitsPerComponent | Sets Bits Per Component IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Bits Per Component DataSet (3:135). The DataSet contains a sequence of one or more bytes describing the number of bits used to encode each component. The sequence is specified by the order of components in DataSet 3:65. |
| setByLine | Sets By Line IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the By-line DataSet (2:80). The DataSet contains the name of the creator of the objectdata, e.g., writer, photographer, or graphic artist. Repeatable (array items represent repeated values), maximum 32 bytes, consisting of graphic characters plus spaces. |
| setByLineTitle | Sets By Line Title IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the By-line Title DataSet (2:85). The DataSet specifies the title of the creator or creators of an objectdata. Repeatable (array items represent repeated values), maximum 32 bytes, consisting of graphic characters plus spaces. |
| setCaption_Abstract | Sets Caption/Abstract IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Caption/Abstract DataSet (2:120). The DataSet contains a textual description of the objectdata, particularly used where the object is not text. Maximum of 2000 bytes, consisting of graphic characters plus carriage-returns, linefeeds, and spaces. |
| setCategory | Sets Category IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Category DataSet (2:15). The DataSet identifies the subject of the objectdata in the opinion of the provider. Maximum three bytes, consisting of alphabetic characters. |
| setCity | Sets City IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the City DataSet (2:90). The DataSet identifies the city of objectdata origin according to guidelines established by the provider. Maximum 32 bytes, consisting of graphic characters plus spaces. |
| setCodedCharacterSet | Sets Coded Character Set IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Coded Character Set DataSet (1:90). The DataSet consists of one or more control functions used for the announcement, invocation, or designation of coded character sets. The control functions follow the ISO 2022 standard and may consist of the escape control character and one or more graphic characters. Contains up to 32 bytes. |
| setColourCalibrationMatrixTable | Sets Colour Calibration Matrix Table IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Colour Calibration Matrix Table DataSet (3:70). The DataSet is no longer required as its contents have been rendered obsolete by the introduction of DataSet P3:66 (ICC Input Colour Profile). |
| setColourPalette | Sets Colour Palette IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Colour Palette DataSet (3:85). The purpose of the Colour Palette is to act as a lookup table mapping the pixel values into the Colour Space defined in Interchange Colour Space DataSet (3:64). Contains up to 524,288 (4 x 65536 x 2) bytes. A number of default palettes may be held to be selected according to the device identifier component of the Picture Number 3:10. |
| setColourRepresentation | Sets Colour Representation IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Colour Representation DataSet (3:60). The DataSet specifies the number of image components and the build-up structure of the image. |
| setColourSequence | Sets Colour Sequence IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Colour Sequence DataSet (3:65). The DataSet specifies the sequence of the components as they appear in the objectdata. |
| setConfirmedObjectDataSize | Sets Confirmed Object Data Size IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the ConfirmedObjectDataSize DataSet (9:10). The DataSet specifies total size of the objectdata, in bytes, without tags. |
| setContact | Sets Contact IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Contact DataSet (2:118). The DataSet identifies the person or organization that can provide further background information on the objectdata. Repeatable (array items represent repeated values), maximum of 128 bytes, consisting of graphic characters plus spaces. |
| setContentLocationCode | Sets Content Location Code IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the ContentLocationCode DataSet (2:26). The DataSet indicates the code of a country/geographical location referenced by the content of the object. Repeatable (array items represent repeated values), 3 bytes consisting of alphabetic characters. |
| setContentLocationName | Sets Content Location Name IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the ContentLocationName DataSet (2:27). The DataSet provides a full, publishable name of a country/geographical location referenced by the content of the object, according to guidelines of the provider. Repeatable (array items represent repeated values), maximum 64 bytes, consisting of graphic characters plus spaces. |
| setCopyrightNotice | Sets Copyright Notice IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the CopyrightNotice DataSet (2:116). The DataSet contains any necessary copyright notice. Contains maximum of 128 bytes, consisting of graphic characters plus spaces. |
| setCountryPrimaryLocationCode | Sets Country Primary Location Code IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Country/PrimaryLocationCode DataSet (2:100). The DataSet indicates the code of the country/primary location where the intellectual property of the objectdata was created, e.g., a photo was taken, an event occured. Contains three bytes consisting of alphabetic characters. |
| setCountryPrimaryLocationName | Sets Country Primary Location Name IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Country/PrimaryLocationName DataSet (2:101). The DataSet provides the full, publishable name of the country/primary location where the intellectual property of the objectdata was created, according to guidelines of the provider. Contains maximum 64 bytes, consisting of graphic characters plus spaces. |
| setCredit | Sets Credit IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Credit DataSet (2:110). The DataSet identifies the provider of the objectdata, not necessarily the owner/creator. Contains maximum of 32 bytes, consisting of graphic characters plus spaces. |
| setDataCompressionMethod | Sets Data Compression method IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Data Compression method DataSet (3:110). The DataSet specifies the provider/owner, type, and version of the compression algorithm. |
| setDateCreated | Sets Date Created IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the DateCreated DataSet (2:55). The DataSet represented in the form CCYYMMDD to designate the date the intellectual content of the objectdata was created rather than the date of the creation of the physical representation. Contains eight bytes, consisting of numeric characters. |
| setDateSent | Sets Date Sent IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Date Sent DataSet (1:70). The DataSet uses the format CCYYMMDD (century, year, month, day) as defined in ISO 8601 to indicate year, month, and day the service sent the material. Contains eight bytes, consisting of numeric characters. |
| setDestination | Sets Destination IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Destination DataSet (1:05). The DataSet is to accommodate some providers who require routing information above the appropriate OSI layers. Repeatable (array items represent repeated values), maximum 1024 bytes, consisting of sequentially contiguous graphic characters. |
| setDigitalCreationDate | Sets Digital Creation Date IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the DigitalCreationDate DataSet (2:62). The DataSet represented in the form CCYYMMDD to designate the date the digital representation of the objectdata was created. Contains eight bytes, consisting of numeric characters. |
| setDigitalCreationTime | Sets Digital Creation Time IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the DigitalCreationTime DataSet (2:63). The DataSet is represented in the form HHMMSS-HHMM to designate the time the digital representation of the objectdata was created. Follows ISO 8601 standard. Contains 11 bytes, consisting of graphic characters. |
| setEditorialUpdate | Sets Editorial Update IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the EditorialUpdate DataSet (2:08). The DataSet indicates the type of update that this object provides to a previous object. Contains 2 bytes, consisting of numeric characters. |
| setEditStatus | Sets Edit Status IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Edit Status DataSet (2:07). The DataSet specifies the status of the objectdata, according to the practice of the provider. Maximum 64 bytes, consisting of graphic characters plus spaces. |
| setEndPoints | Sets End Points IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the EndPoints DataSet (3:125). The DataSet contains the values representing minimum and maximum density for each component. |
| setEnvelopeNumber | Sets Envelope Number IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the EnvelopeNumber DataSet (1:40). Characters of the DataSet form a number that will be unique for the date specified in 1:70 and for the Service Identifier specified in 1:30. Contains eight bytes, consisting of numeric characters. |
| setEnvelopePriority | Sets Envelope Priority IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the EnvelopePriority DataSet (1:60). The DataSet specifies the envelope handling priority and not the editorial urgency (see 2:10, Urgency). '1' indicates the most urgent, '5' the normal urgency, and '8' the least urgent copy. The numeral '9' indicates a User Defined Priority. The numeral '0' is reserved for future use. Contains a single byte, consisting of a numeric character. |
| setExcursionTolerance | Sets Excursion Tolerance IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the ExcursionTolerance DataSet (3:130). The DataSet indicates if values outside the range defined by the end points in DataSet 3:125 may occur. |
| setExpirationDate | Sets Expiration Date IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the ExpirationDate DataSet (2:37). The DataSet designates in the form CCYYMMDD the latest date the provider or owner intends the objectdata to be used. Contains eight bytes, consisting of numeric characters. |
| setExpirationTime | Sets Expiration Time IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the ExpirationTime DataSet (2:38). The DataSet designates in the form HHMMSS-HHMM the latest time the provider or owner intends the objectdata to be used. Contains 11 bytes, consisting of graphic characters. |
| setFileFormat | Sets File Format IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the File Format DataSet (1:20). The DataSet represents the file format. The file format must be registered with IPTC or NAA with a unique number. The information is used to route the data to the appropriate system and to allow the receiving system to perform the appropriate actions thereto. |
| setFileFormatVersion | Sets File Format Version IPTC dataset. This method accesses the File Format Version DataSet (1:22). The DataSet contains a binary number representing the particular version of the File Format specified in 1:20. Method replaces the current tag value if the tag is present in the metadata tree, adds the tag if it was not present, or deletes the tag if a null value is passed.
See the IPTC - NAA Information Interchange Model ver. 4.1 specification for tag usage details. |
| setFixtureIdentifier | Sets Fixture Identifier IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Fixture Identifier DataSet (2:22). The DataSet identifies objectdata that recurs often and predictably. Enables users to immediately find or recall such an object. Contains maximum 32 bytes, consisting of graphic characters. |
| setGammaCompensatedValue | Sets Gamma Compensated Value IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the GammaCompensatedValue DataSet (3:145). The DataSet specifies the value of gamma for the device multiplied by 100. If this DataSet is omitted, receiving equipment should assume that a gamma value of 2.22 applies. |
| setHeadline | Sets Headline IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Headline DataSet (2:105). The DataSet contains a publishable entry providing a synopsis of the contents of the objectdata. Contains maximum of 256 bytes, consisting of graphic characters plus spaces. |
| setICCInputColourProfile | Sets ICC Input Colour Profile IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the ICC InputColourProfile DataSet (3:66). The DataSet specifies the International Color Consortium profile for the scanning/source device used to generate the digital image files. |
| setImageOrientation | Sets Image Orientation IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the ImageOrientation DataSet (2:131). The DataSet indicates the layout of the image area. |
| setImageRotation | Sets Image Rotation IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the ImageRotation DataSet (3:102). The DataSet indicates the clockwise rotation applied to the image for presentation. |
| setImageType | Sets Image Type IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Image Type DataSet (2:130). The DataSet specifies whether the objectdata contains an image or a supplemental object, number of channels in the image and exact content of the objectdata in terms of colour composition. |
| setInterchangeColourSpace | Sets Interchange Colour Space IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the InterchangeColourSpace DataSet (3:64). The DataSet indicates the colour space in which the pixel values are expressed for each component in the image. |
| setKeywords | Sets Keywords IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Keywords DataSet (2:25). The DataSet indicates specific information retrieval words. Repeatable (array items represent repeated values), maximum 64 bytes, consisting of graphic characters plus spaces. |
| setLanguageIdentifier | Sets Language Identifier IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Language Identifier DataSet (2:135). The DataSet describes the major national language of the object, according to the 2-letter codes of ISO 639:1988. Contains two or three bytes, consisting of alphabetic characters. |
| setLookupTable | Sets Lookup Table IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the LookupTable DataSet (3:80). The DataSet consists of one, three or four one-dimensional lookup tables (LUT).The LUT relates to the image data in the colour space defined in DataSet 3:64 and specifies the correction to apply to the pixel values before display or printing of the image. |
| setMaximumDensityRange | Sets Maximum Density Range IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the MaximumDensityRange DataSet (3:140). The DataSet represents the difference between the lowest density and the highest density points that can be encoded by the originating system. |
| setMaximumObjectDataSize | Sets Maximum Object Data Size IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the MaximumObjectDataSize DataSet (7:95). When objectdata size is not known, the DataSet indicates the largest size, expressed in bytes, that the objectdata can possibly have, not including tags. |
| setMaxSubfileSize | Sets Max Subfile Size IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Max SubfileSize DataSet (7:20). The DataSet indicates the maximum size for the following Subfile DataSet(s). |
| setModelVersion | Sets Model Version IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Model Version DataSet (1:00). The DataSet identifies the version of the Information Interchange Model, Part I, utilized by the provider. |
| setNumberOfBitsPerSample | Sets Number Of Bits Per Sample IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Number of Bits per Sample DataSet (3:86). The DataSet indicates the number of bits per pixel value used as entries in the Colour Palette. |
| setNumberOfIndexEntries | Sets Number Of Index Entries IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Number of Index Entries DataSet (3:84). The DataSet represents the number of index entries in the DataSet 3:85 (Colour Palette). |
| setNumberOfLines | Sets Number Of Line IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Number of Lines DataSet (3:30). The DataSet represents the number of scan lines comprising the image for the component with the highest resolution. |
| setObjectAttributeReference | Sets Object Attribute Reference IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the ObjectAttributeReference DataSet (2:04). The DataSet defines the nature of the object independent of the Subject. Repeatable (array items represent repeated values). |
| setObjectCycle | Sets Object Cycle IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Object Cycle DataSet (2:75). The DataSet represents object cycle, virtually only used in North America. |
| setObjectDataPreviewData | Sets Object Data Preview Data IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the ObjectData Preview Data DataSet (2:202). Maximum size: 256000 bytes. |
| setObjectDataPreviewFileFormat | Sets ObjectData Preview File Format DataSet (2:200).
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the ObjectData Preview File Format DataSet (2:200). The DataSet represents the file format of the ObjectData Preview. |
| setObjectDataPreviewFileFormatVersion | Sets Object Data Preview File Format Version IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the ObjectData Preview File Format Version DataSet (2:201). The DataSet represents the particular version of the ObjectData Preview File Format specified in 2:200. |
| setObjectDataSizeAnnounced | Sets Object Data Size Announced IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the ObjectData Size Announced DataSet (7:90). The DataSet represents the overall size of the objectdata, expressed in bytes, not including tags, if that size is known when transfer commences. |
| setObjectName | Sets Object Name IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Object Name DataSet (2:05). The DataSet used as a shorthand reference for the object. Maximum 64 bytes, consisting of graphic characters plus spaces. |
| setObjectTypeReference | Sets Object Type Reference IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Object Type Reference DataSet (2:03). The DataSet is used to distinguish between different types of objects within the IIM. |
| setOriginalTransmissionReference | Sets Original Transmission Reference IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Original Transmission Reference DataSet (2:103). The DataSet represents the location of original transmission according to practices of the provider. Maximum 32 bytes, consisting of graphic characters plus spaces. |
| setOriginatingProgram | Sets Originating Program IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Originating Program DataSet (2:65). The DataSet identifies the type of program used to originate the objectdata. Maximum of 32 bytes, consisting of graphic characters plus spaces. |
| setPictureNumber | Sets Picture Number IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Picture Number DataSet (3:10). The DataSet provides a universally unique reference to an image. |
| setPixelSizeInScanningDirection | Sets Pixel Size In Scanning Direction IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Pixel Size In Scanning Direction DataSet (3:40). The DataSet indicates the number of pixels per unit length in the scanning direction. |
| setPixelSizePerpendicularToScanningDirection | Sets Pixel Size Perpendicular To Scanning Direction IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Pixel Size Perpendicular To Scanning Direction DataSet (3:50). The DataSet indicates the number of pixels per unit length perpendicular to the scanning direction. |
| setPixelsPerLine | Sets Pixels Per Line IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Pixels Per Line DataSet (3:20). The DataSet represents the number of pixels in a scan line for the component with the highest resolution. |
| setProductID | Sets ProductID IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Product I.D. DataSet (1:50). The DataSet allows a provider to identify subsets of its overall service. Used to provide receiving organization data on which to select, route, or otherwise handle data. Repeatable (array items represent repeated values). Up to 32 bytes, consisting of graphic characters. |
| setProgramVersion | Sets Program Version IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Program Version DataSet (2:70). The DataSet identifies the version of the program mentioned in Originating Program DataSet (2:65). Invalid if 2:65 is not present. Maximum of 10 bytes, consisting of graphic characters plus spaces. |
| setProvinceState | Sets Province State IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Province/State DataSet (2:95). The DataSet identifies Province/State of origin according to guidelines established by the provider. Maximum 32 bytes, consisting of graphic characters plus spaces. |
| setQuantisationMethod | Sets Quantisation method IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Quantisation method DataSet (3:120). The DataSet identifies the quantisation law. The relations between different quantisation methods are described in DNPR Guideline 1. |
| setRasterizedCaption | Sets Rasterized Caption IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Rasterized Caption DataSet (2:125). The DataSet contains the rasterized objectdata description and is used where characters that have not been coded are required for the caption. Contains 7360 bytes, consisting of binary data, one bit per pixel, two value bitmap where 1 (one) represents black and 0 (zero) represents white. Image width 460 pixels and image height 128 pixels. Scanning direction bottom to top, left to right. |
| setRecord2Version | Sets Record2 Version IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Record II Version DataSet (2:00). The DataSet identifies the version of the Information Interchange Model, Part II (Record 2:xx), utilised by the provider. Version numbers are assigned by IPTC and NAA. |
| setRecord3Version | Sets Record3 Version IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Record Version DataSet (3:00). The DataSet represents the version of the Digital Newsphoto Parameter Record utilized by the provider. Version numbers are assigned by IPTC and NAA. |
| setReferenceDate | Sets Reference Date IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Reference Date DataSet (2:47). The DataSet identifies the date of a prior envelope to which the current object refers. Repeatable (array items represent repeated values). Uses the format CCYYMMDD (century, year, month, day) as defined in ISO 8601 to indicate year, month and day. |
| setReferenceNumber | Sets Reference Number IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Reference Number DataSet (2:50). The DataSet identifies the Envelope Number of a prior envelope to which the current object refers. Repeatable (array items represent repeated values), eight bytes, consisting of numeric characters. |
| setReferenceService | Sets Reference Service IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Reference Service DataSet (2:45). The DataSet identifies the Service Identifier of a prior envelope to which the current object refers. Repeatable (array items represent repeated values), up to 10 bytes, consisting of graphic characters. |
| setReleaseDate | Sets Release Date IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Release Date DataSet (2:30). The DataSet designates in the form CCYYMMDD the earliest date the provider intends the object to be used. Follows ISO 8601 standard. Eight bytes, consisting of numeric characters. |
| setReleaseTime | Sets Release Time IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Release Time DataSet (2:35). The DataSet designates in the form HHMMSS-HHMM the earliest time the provider intends the object to be used. Follows ISO 8601 standard. Contains 11 bytes, consisting of graphic characters. |
| setSamplingStructure | Sets Sampling structure IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Sampling structure DataSet (3:90). The DataSet defines the spatial and temporal relationship between pixels. |
| setScanningDirection | Sets Scanning Direction IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Scanning Direction DataSet (3:100). The DataSet indicates the correct relative two dimensional order of the pixels in the objectdata. |
| setServiceIdentifier | Sets Service Identifier IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Service Identifier DataSet (1:30). The DataSet identifies the provider and product. Contains up to 10 bytes, consisting of graphic characters. |
| setSizeMode | Sets Size Mode IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Size Mode DataSet (7:10). The DataSet indicates whether the size of the objectdata is known at the beginning of transfer. |
| setSource | Sets Source IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Source DataSet (2:115). The DataSet identifies the original owner of the intellectual content of the objectdata. This could be an agency, a member of an agency or an individual. Maximum of 32 bytes, consisting of graphic characters plus spaces. |
| setSpecialInstructions | Sets Special Instructions IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Special Instructions DataSet (2:40). The DataSet contains other editorial instructions concerning the use of the objectdata, such as embargoes and warnings. Maximum 256 bytes, consisting of graphic characters plus spaces. |
| setSubjectReference | Sets Subject Reference IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Subject Reference DataSet (2:12). The DataSet represents a structured definition of the subject matter. Repeatable (array items represent repeated values). |
| setSublocation | Sets Sublocation IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Sublocation DataSet (2:92). The DataSet identifies the location within a city from which the objectdata originates, according to guidelines established by the provider. Maximum 32 bytes, consisting of graphic characters plus spaces. |
| setSupplementalCategory | Sets Supplemental Category IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Supplemental Category DataSet (2:20). The DataSet further refines the subject of an objectdata. Repeatable (array items represent repeated values), maximum 32 bytes, consisting of graphic characters plus spaces. |
| setSupplementType | Sets Supplement Type IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Supplement Type. DataSet (3:55). The DataSet indicates the image content. |
| setTimeCreated | Sets Time Created IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Time Created DataSet (2:60). The DataSet designates the time the intellectual content of the objectdata current source material was created rather than the creation of the physical representation. Contains 11 bytes, consisting of graphic characters. Represented in the form HHMMSS-HHMM. Follows ISO 8601 standard. |
| setTimeSent | Sets Time Sent IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Time Sent DataSet (1:80). The DataSet indicates the time the service sent the material. Contains 11 bytes, consisting of graphic characters. Uses the format HHMMSS-HHMM where HHMMSS refers to local hour, minute, and seconds and HHMM refers to hours and minutes ahead (+) or behind (-) Universal Coordinated Time as described in ISO 8601. |
| setUNO | Sets UNO IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the UNO DataSet (1:100). The UNO (Unique Name of Object) DataSet provides eternal, globally unique identification for objects as specified in the IIM, independent of provider and for any media form. The provider must ensure the UNO is unique. Objects with the same UNO are identical. |
| setUrgency | Sets Urgency IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Urgency DataSet (2:10). The DataSet Specifies the editorial urgency of content and not necessarily the envelope handling priority. |
| setWriter_Editor | Sets Writer/Editor IPTC dataset.
Method replacesthe tag value if the tag is present in the metadata tree, or null otherwise. This method accesses the Writer/Editor DataSet (2:122). The DataSet contains identification of the name of the person involved in the writing, editing, or correcting the objectdata or caption/abstract. Repeatable (array items represent repeated values), maximum 32 bytes, consisting of graphic characters plus spaces. |