Apache PDFBox 3.0.4 · org.apache.xmpbox.schema.TiffSchema

Field Summary

Modifier and Type	Field and Description
public static final String	ARTIST
public static final String	BITS_PER_SAMPLE
public static final String	COMPRESSION
public static final String	COPYRIGHT
public static final String	DATE_TIME
public static final String	IMAGE_DESCRIPTION
public static final String	IMAGE_LENGTH
public static final String	IMAGE_WIDTH
public static final String	MAKE
public static final String	MODEL
public static final String	ORIENTATION
public static final String	PHOTOMETRIC_INTERPRETATION
public static final String	PLANAR_CONFIGURATION
public static final String	PRIMARY_CHROMATICITIES
public static final String	REFERENCE_BLACK_WHITE
public static final String	RESOLUTION_UNIT
public static final String	SAMPLES_PER_PIXEL
public static final String	SOFTWARE
public static final String	TRANSFER_FUNCTION
public static final String	WHITE_POINT
public static final String	XRESOLUTION
public static final String	YCB_CR_COEFFICIENTS
public static final String	YCB_CR_POSITIONING
public static final String	YCB_CR_SUB_SAMPLING
public static final String	YRESOLUTION

Constructor Summary

Access	Constructor and Description
public	TiffSchema(XMPMetadata metadata)
public	TiffSchema(XMPMetadata metadata, String prefix)

Method Summary

Modifier and Type	Method and Description
public void	addCopyright(String language of the copyright lang, String copyright text value) Add a Copyright property value for a specified language
public void	addImageDescription(String language of the ImageDescription property. lang, String image description text value) Add an ImageDescription value for a specified language.
public String	Returns: the Artist property getArtist() Return the Artist property as String
public ProperNameType	Returns: artist ProperNameType getArtistProperty() Return the artist property
public String	Returns: copyright value or null if it doesn't exist. getCopyright(String expected language lang) Return the Copyright value as String in expected language
public String	Returns: The Copyright property value or null if it doesn't exist. getCopyright() Return the Copyright property value as String in default language
public List<String>	Returns: a list of languages or null if it doesn't exist. getCopyrightLanguages() Return the list of language existing for the Copyright property.
public ArrayProperty	Returns: the Copyright property getCopyrightProperty() Return the Copyright property object
public String	Returns: The ImageDescription property value or null if it doesn't exist. getImageDescription(String The expected language. lang) Return the ImageDescription property value as String in a specified language.
public String	Returns: the ImageDescription value or null if it doesn't exist. getImageDescription() Return the ImageDescription property as String in the default language.
public List<String>	Returns: a list of languages or null if it doesn't exist. getImageDescriptionLanguages() Return the list of language existing for the ImageDescription property.
public ArrayProperty	Returns: the ImageDescription property. getImageDescriptionProperty() Return the ImageDescription property object.
public void	setArtist(String the name of the artist text) Set the name of the artist

Inherited from org.apache.xmpbox.schema.XMPSchema:: addBagValue addBagValueAsSimple addQualifiedBagValue addSequenceDateValueAsSimple addUnqualifiedSequenceDateValue addUnqualifiedSequenceValue addUnqualifiedSequenceValue getAboutAttribute getAboutValue getAbstractProperty getBooleanProperty getBooleanPropertyValue getBooleanPropertyValueAsSimple getDateProperty getDatePropertyValue getDatePropertyValueAsSimple getIntegerProperty getIntegerPropertyValue getIntegerPropertyValueAsSimple getUnqualifiedArrayList getUnqualifiedBagValueList getUnqualifiedLanguagePropertyLanguagesValue getUnqualifiedLanguagePropertyValue getUnqualifiedSequenceDateValueList getUnqualifiedSequenceValueList getUnqualifiedTextProperty getUnqualifiedTextPropertyValue instanciateSimple merge removeUnqualifiedArrayValue removeUnqualifiedBagValue removeUnqualifiedSequenceDateValue removeUnqualifiedSequenceValue removeUnqualifiedSequenceValue reorganizeAltOrder setAbout setAboutAsSimple setBooleanProperty setBooleanPropertyValue setBooleanPropertyValueAsSimple setDateProperty setDatePropertyValue setDatePropertyValueAsSimple setIntegerProperty setIntegerPropertyValue setIntegerPropertyValueAsSimple setTextProperty setTextPropertyValue setTextPropertyValueAsSimple setUnqualifiedLanguagePropertyValue

Field Detail

ARTIST	back to summary
public static final String ARTIST Annotations @PropertyType type:ProperName card:Simple

BITS_PER_SAMPLE	back to summary
public static final String BITS_PER_SAMPLE Annotations @PropertyType type:Integer card:Seq

COMPRESSION	back to summary
public static final String COMPRESSION Annotations @PropertyType type:Integer card:Simple

COPYRIGHT	back to summary
public static final String COPYRIGHT Annotations @PropertyType type:LangAlt card:Simple

DATE_TIME	back to summary
public static final String DATE_TIME Annotations @PropertyType type:Date card:Simple

IMAGE_DESCRIPTION	back to summary
public static final String IMAGE_DESCRIPTION Annotations @PropertyType type:LangAlt card:Simple

IMAGE_LENGTH	back to summary
public static final String IMAGE_LENGTH Annotations @PropertyType type:Integer card:Simple

IMAGE_WIDTH	back to summary
public static final String IMAGE_WIDTH Annotations @PropertyType type:Integer card:Simple

MAKE	back to summary
public static final String MAKE Annotations @PropertyType type:ProperName card:Simple

MODEL	back to summary
public static final String MODEL Annotations @PropertyType type:ProperName card:Simple

ORIENTATION	back to summary
public static final String ORIENTATION Annotations @PropertyType type:Integer card:Simple

PHOTOMETRIC_INTERPRETATION	back to summary
public static final String PHOTOMETRIC_INTERPRETATION Annotations @PropertyType type:Integer card:Simple

PLANAR_CONFIGURATION	back to summary
public static final String PLANAR_CONFIGURATION Annotations @PropertyType type:Integer card:Simple

PRIMARY_CHROMATICITIES	back to summary
public static final String PRIMARY_CHROMATICITIES Annotations @PropertyType type:Rational card:Seq

REFERENCE_BLACK_WHITE	back to summary
public static final String REFERENCE_BLACK_WHITE Annotations @PropertyType type:Rational card:Seq

RESOLUTION_UNIT	back to summary
public static final String RESOLUTION_UNIT Annotations @PropertyType type:Integer card:Simple

SAMPLES_PER_PIXEL	back to summary
public static final String SAMPLES_PER_PIXEL Annotations @PropertyType type:Integer card:Simple

SOFTWARE	back to summary
public static final String SOFTWARE Annotations @PropertyType type:AgentName card:Simple

TRANSFER_FUNCTION	back to summary
public static final String TRANSFER_FUNCTION Annotations @PropertyType type:Integer card:Seq

WHITE_POINT	back to summary
public static final String WHITE_POINT Annotations @PropertyType type:Rational card:Seq

XRESOLUTION	back to summary
public static final String XRESOLUTION Annotations @PropertyType type:Rational card:Simple

YCB_CR_COEFFICIENTS	back to summary
public static final String YCB_CR_COEFFICIENTS Annotations @PropertyType type:Rational card:Seq

YCB_CR_POSITIONING	back to summary
public static final String YCB_CR_POSITIONING Annotations @PropertyType type:Integer card:Seq

YCB_CR_SUB_SAMPLING	back to summary
public static final String YCB_CR_SUB_SAMPLING Annotations @PropertyType type:Integer card:Simple

YRESOLUTION	back to summary
public static final String YRESOLUTION Annotations @PropertyType type:Rational card:Simple

Constructor Detail

TiffSchema	back to summary
public TiffSchema(XMPMetadata metadata)

TiffSchema	back to summary
public TiffSchema(XMPMetadata metadata, String prefix)

Method Detail

addCopyright	back to summary
public void addCopyright(String lang, String value) Add a Copyright property value for a specified language Parameters lang:String language of the copyright value:String copyright text

addCopyright

back to summary

public void addCopyright(String lang, String value)

Add a Copyright property value for a specified language

Parameters

lang:String: language of the copyright
value:String: copyright text

addImageDescription	back to summary
public void addImageDescription(String lang, String value) Add an ImageDescription value for a specified language. Parameters lang:String language of the ImageDescription property. value:String image description text

addImageDescription

back to summary

public void addImageDescription(String lang, String value)

Add an ImageDescription value for a specified language.

Parameters

lang:String: language of the ImageDescription property.
value:String: image description text

getArtist	back to summary
public String getArtist() Return the Artist property as String Returns:String the Artist property

getArtist

back to summary

public String getArtist()

Return the Artist property as String

Returns:String: the Artist property

getArtistProperty	back to summary
public ProperNameType getArtistProperty() Return the artist property Returns:ProperNameType artist ProperNameType

getArtistProperty

back to summary

public ProperNameType getArtistProperty()

Return the artist property

Returns:ProperNameType: artist ProperNameType

getCopyright	back to summary
public String getCopyright(String lang) throws BadFieldValueException Return the Copyright value as String in expected language Parameters lang:String expected language Returns:String copyright value or null if it doesn't exist. Exceptions BadFieldValueException: If the Copyright property is not a multi-lingual property

getCopyright

back to summary

public String getCopyright(String lang) throws BadFieldValueException

Return the Copyright value as String in expected language

Parameters

lang:String: expected language

Returns:String

Exceptions

BadFieldValueException:: If the Copyright property is not a multi-lingual property

getCopyright	back to summary
public String getCopyright() throws BadFieldValueException Return the Copyright property value as String in default language Returns:String The Copyright property value or null if it doesn't exist. Exceptions BadFieldValueException: If the Copyright property is not a multi-lingual property

getCopyright

back to summary

public String getCopyright() throws BadFieldValueException

Return the Copyright property value as String in default language

Returns:String

The Copyright property value or null if it doesn't exist.

Exceptions

BadFieldValueException:: If the Copyright property is not a multi-lingual property

getCopyrightLanguages	back to summary
public List<String> getCopyrightLanguages() throws BadFieldValueException Return the list of language existing for the Copyright property. Returns:List<String> a list of languages or null if it doesn't exist. Exceptions BadFieldValueException: If the Copyright property is not a multi-lingual property

getCopyrightLanguages

back to summary

public List<String> getCopyrightLanguages() throws BadFieldValueException

Return the list of language existing for the Copyright property.

Returns:List<String>

a list of languages or null if it doesn't exist.

Exceptions

BadFieldValueException:: If the Copyright property is not a multi-lingual property

getCopyrightProperty	back to summary
public ArrayProperty getCopyrightProperty() Return the Copyright property object Returns:ArrayProperty the Copyright property

getCopyrightProperty

back to summary

public ArrayProperty getCopyrightProperty()

Return the Copyright property object

Returns:ArrayProperty: the Copyright property

getImageDescription	back to summary
public String getImageDescription(String lang) throws BadFieldValueException Return the ImageDescription property value as String in a specified language. Parameters lang:String The expected language. Returns:String The ImageDescription property value or null if it doesn't exist. Exceptions BadFieldValueException: If the ImageDescription property is not a multi-lingual property.

getImageDescription

back to summary

public String getImageDescription(String lang) throws BadFieldValueException

Return the ImageDescription property value as String in a specified language.

Parameters

lang:String: The expected language.

Returns:String

The ImageDescription property value or null if it doesn't exist.

Exceptions

BadFieldValueException:: If the ImageDescription property is not a multi-lingual property.

getImageDescription	back to summary
public String getImageDescription() throws BadFieldValueException Return the ImageDescription property as String in the default language. Returns:String the ImageDescription value or null if it doesn't exist. Exceptions BadFieldValueException: If the ImageDescription property is not a multi-lingual property.

getImageDescription

back to summary

public String getImageDescription() throws BadFieldValueException

Return the ImageDescription property as String in the default language.

Returns:String

the ImageDescription value or null if it doesn't exist.

Exceptions

BadFieldValueException:: If the ImageDescription property is not a multi-lingual property.

getImageDescriptionLanguages	back to summary
public List<String> getImageDescriptionLanguages() throws BadFieldValueException Return the list of language existing for the ImageDescription property. Returns:List<String> a list of languages or null if it doesn't exist. Exceptions BadFieldValueException: If the ImageDescription property is not a multi-lingual property.

getImageDescriptionLanguages

back to summary

public List<String> getImageDescriptionLanguages() throws BadFieldValueException

Return the list of language existing for the ImageDescription property.

Returns:List<String>

a list of languages or null if it doesn't exist.

Exceptions

BadFieldValueException:: If the ImageDescription property is not a multi-lingual property.

getImageDescriptionProperty	back to summary
public ArrayProperty getImageDescriptionProperty() Return the ImageDescription property object. Returns:ArrayProperty the ImageDescription property.

getImageDescriptionProperty

back to summary

public ArrayProperty getImageDescriptionProperty()

Return the ImageDescription property object.

Returns:ArrayProperty: the ImageDescription property.

setArtist	back to summary
public void setArtist(String text) Set the name of the artist Parameters text:String the name of the artist

setArtist

back to summary

public void setArtist(String text)

Set the name of the artist

Parameters

text:String: the name of the artist

public Class TiffSchema

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail