Package org.apache.xmpbox.schema

Class TiffSchema

java.lang.Object

org.apache.xmpbox.type.AbstractField

org.apache.xmpbox.type.AbstractComplexProperty

org.apache.xmpbox.type.AbstractStructuredType

org.apache.xmpbox.schema.XMPSchema

org.apache.xmpbox.schema.TiffSchema

public class TiffSchema
extends XMPSchema

Field Summary

Fields

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

Fields inherited from class org.apache.xmpbox.type.AbstractStructuredType

STRUCTURE_ARRAY_NAME

Constructor Summary

Constructors

Constructor	Description
TiffSchema(XMPMetadata metadata)
TiffSchema(XMPMetadata metadata, java.lang.String prefix)

Method Summary

Modifier and Type	Method	Description
void	addCopyright(java.lang.String lang, java.lang.String value)	Add a Copyright property value for a specified language
void	addImageDescription(java.lang.String lang, java.lang.String value)	Add an ImageDescription value for a specified language.
java.lang.String	getArtist()	Return the Artist property as String
ProperNameType	getArtistProperty()	Return the artist property
java.lang.String	getCopyright()	Return the Copyright property value as String in default language
java.lang.String	getCopyright(java.lang.String lang)	Return the Copyright value as String in expected language
java.util.List<java.lang.String>	getCopyrightLanguages()	Return the list of language existing for the Copyright property.
ArrayProperty	getCopyrightProperty()	Return the Copyright property object
java.lang.String	getImageDescription()	Return the ImageDescription property as String in the default language.
java.lang.String	getImageDescription(java.lang.String lang)	Return the ImageDescription property value as String in a specified language.
java.util.List<java.lang.String>	getImageDescriptionLanguages()	Return the list of language existing for the ImageDescription property.
ArrayProperty	getImageDescriptionProperty()	Return the ImageDescription property object.
void	setArtist(java.lang.String text)	Set the name of the artist

Methods inherited from class 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

Methods inherited from class org.apache.xmpbox.type.AbstractStructuredType

addSimpleProperty, createArrayProperty, createTextType, getDatePropertyAsCalendar, getNamespace, getPreferedPrefix, getPrefix, getPropertyValueAsString, setNamespace, setPrefix

Methods inherited from class org.apache.xmpbox.type.AbstractComplexProperty

addNamespace, addProperty, getAllNamespacesWithPrefix, getAllProperties, getArrayProperty, getContainer, getFirstEquivalentProperty, getNamespacePrefix, getProperty, removeProperty

Methods inherited from class org.apache.xmpbox.type.AbstractField

containsAttribute, getAllAttributes, getAttribute, getMetadata, getPropertyName, removeAttribute, setAttribute, setPropertyName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

IMAGE_DESCRIPTION

public static final java.lang.String IMAGE_DESCRIPTION

See Also:

Constant Field Values

COPYRIGHT

public static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

ARTIST

public static final java.lang.String ARTIST

See Also:

Constant Field Values

IMAGE_WIDTH

public static final java.lang.String IMAGE_WIDTH

See Also:

Constant Field Values

IMAGE_LENGTH

public static final java.lang.String IMAGE_LENGTH

See Also:

Constant Field Values

BITS_PER_SAMPLE

public static final java.lang.String BITS_PER_SAMPLE

See Also:

Constant Field Values

COMPRESSION

public static final java.lang.String COMPRESSION

See Also:

Constant Field Values

PHOTOMETRIC_INTERPRETATION

public static final java.lang.String PHOTOMETRIC_INTERPRETATION

See Also:

Constant Field Values

ORIENTATION

public static final java.lang.String ORIENTATION

See Also:

Constant Field Values

SAMPLES_PER_PIXEL

public static final java.lang.String SAMPLES_PER_PIXEL

See Also:

Constant Field Values

PLANAR_CONFIGURATION

public static final java.lang.String PLANAR_CONFIGURATION

See Also:

Constant Field Values

YCB_CR_SUB_SAMPLING

public static final java.lang.String YCB_CR_SUB_SAMPLING

See Also:

Constant Field Values

YCB_CR_POSITIONING

public static final java.lang.String YCB_CR_POSITIONING

See Also:

Constant Field Values

XRESOLUTION

public static final java.lang.String XRESOLUTION

See Also:

Constant Field Values

YRESOLUTION

public static final java.lang.String YRESOLUTION

See Also:

Constant Field Values

RESOLUTION_UNIT

public static final java.lang.String RESOLUTION_UNIT

See Also:

Constant Field Values

TRANSFER_FUNCTION

public static final java.lang.String TRANSFER_FUNCTION

See Also:

Constant Field Values

WHITE_POINT

public static final java.lang.String WHITE_POINT

See Also:

Constant Field Values

PRIMARY_CHROMATICITIES

public static final java.lang.String PRIMARY_CHROMATICITIES

See Also:

Constant Field Values

YCB_CR_COEFFICIENTS

public static final java.lang.String YCB_CR_COEFFICIENTS

See Also:

Constant Field Values

REFERENCE_BLACK_WHITE

public static final java.lang.String REFERENCE_BLACK_WHITE

See Also:

Constant Field Values

DATE_TIME

public static final java.lang.String DATE_TIME

See Also:

Constant Field Values

SOFTWARE

public static final java.lang.String SOFTWARE

See Also:

Constant Field Values

MAKE

public static final java.lang.String MAKE

See Also:

Constant Field Values

MODEL

public static final java.lang.String MODEL

See Also:

Constant Field Values

Constructor Detail

TiffSchema

public TiffSchema(XMPMetadata metadata)

TiffSchema

public TiffSchema(XMPMetadata metadata,
                  java.lang.String prefix)

Method Detail

getArtistProperty

public ProperNameType getArtistProperty()

Return the artist property

Returns:

artist ProperNameType

getArtist

public java.lang.String getArtist()

Return the Artist property as String

Returns:

the Artist property

setArtist

public void setArtist(java.lang.String text)

Set the name of the artist

Parameters:

text - the name of the artist

getImageDescriptionProperty

public ArrayProperty getImageDescriptionProperty()

Return the ImageDescription property object.

Returns:

the ImageDescription property.

getImageDescriptionLanguages

public java.util.List<java.lang.String> getImageDescriptionLanguages()
                                                              throws BadFieldValueException

Return the list of language existing for the ImageDescription property.

Returns:

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

Throws:

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

getImageDescription

public java.lang.String getImageDescription(java.lang.String lang)
                                     throws BadFieldValueException

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

Parameters:

lang - The expected language.

Returns:

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

Throws:

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

getImageDescription

public java.lang.String getImageDescription()
                                     throws BadFieldValueException

Return the ImageDescription property as String in the default language.

Returns:

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

Throws:

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

addImageDescription

public void addImageDescription(java.lang.String lang,
                                java.lang.String value)

Add an ImageDescription value for a specified language.

Parameters:

lang - language of the ImageDescription property.

value - image description text

getCopyrightProperty

public ArrayProperty getCopyrightProperty()

Return the Copyright property object

Returns:

the Copyright property

getCopyrightLanguages

public java.util.List<java.lang.String> getCopyrightLanguages()
                                                       throws BadFieldValueException

Return the list of language existing for the Copyright property.

Returns:

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

Throws:

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

getCopyright

public java.lang.String getCopyright(java.lang.String lang)
                              throws BadFieldValueException

Return the Copyright value as String in expected language

Parameters:

lang - expected language

Returns:

copyright value or null if it doesn't exist.

Throws:

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

getCopyright

public java.lang.String getCopyright()
                              throws BadFieldValueException

Return the Copyright property value as String in default language

Returns:

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

Throws:

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

addCopyright

public void addCopyright(java.lang.String lang,
                         java.lang.String value)

Add a Copyright property value for a specified language

Parameters:

lang - language of the copyright

value - copyright text