Top Description Fields Constructors Methods
org.apache.xmpbox.schema

public Class XMPBasicSchema

extends XMPSchema
Class Inheritance
Annotations
@StructuredType
preferedPrefix:xmp
namespace:http://ns.adobe.com/xap/1.0/
Imports
java.util.ArrayList, .Calendar, .List, org.apache.xmpbox.XMPMetadata, org.apache.xmpbox.type.AbstractField, .AgentNameType, .ArrayProperty, .BadFieldValueException, .Cardinality, .DateType, .IntegerType, .PropertyType, .StructuredType, .TextType, .ThumbnailType, .Types, .URLType
Representation of XMPBasic Schema
Author
a183132

Field Summary

Modifier and TypeField and Description
public static final String
ADVISORY

private ArrayProperty
altThumbs

public static final String
BASEURL

public static final String
CREATEDATE

public static final String
CREATORTOOL

public static final String
IDENTIFIER

public static final String
LABEL

public static final String
METADATADATE

public static final String
MODIFIER_DATE

public static final String
MODIFYDATE

public static final String
NICKNAME

public static final String
RATING

public static final String
THUMBNAILS

Constructor Summary

AccessConstructor and Description
public
XMPBasicSchema(XMPMetadata
The metadata to attach this schema
metadata)

Constructor of XMPBasic schema with preferred prefix

public
XMPBasicSchema(XMPMetadata
The metadata to attach this schema
metadata, String
The prefix to assign
ownPrefix)

Constructor of XMPBasic schema with specified prefix

Method Summary

Modifier and TypeMethod and Description
public void
addAdvisory(String
the value to add
xpath)

Add a property specification that were edited outside the authoring application

public void
addIdentifier(String
the identifier value to add
text)

Add a text string which unambiguously identify the resource within a given context

public void
addThumbnails(Integer
height format
height, Integer
width format
width, String
thumbnail format
format, String
Image data
img)

Add thumbnail to thumbnails list

public List<String>

Returns:

list of adivory values
getAdvisory()

Get the Advisory property values

public ArrayProperty

Returns:

the advisory property
getAdvisoryProperty()

Get the Advisory property

public String

Returns:

the base url value
getBaseURL()

Get the BaseURL property value

public TextType

Returns:

the base url property
getBaseURLProperty()

Get the BaseURL property

public Calendar

Returns:

the CreateDate value
getCreateDate()

Get the CreateDate property value

public DateType

Returns:

the CreateDate property
getCreateDateProperty()

Get the CreateDate property

public String

Returns:

the CreationTool value
getCreatorTool()

Get the CreationTool property value

public TextType

Returns:

the CreationTool property
getCreatorToolProperty()

Get the CreationTool property

public List<String>

Returns:

list of all identifier values
getIdentifiers()

Get the Identifier property values

public ArrayProperty

Returns:

the Identifier property
getIdentifiersProperty()

Get the Identifier property

public String

Returns:

the label value
getLabel()

Get the label property value

public TextType

Returns:

the label property
getLabelProperty()

Get the label property

public Calendar

Returns:

the MetadataDate value
getMetadataDate()

Get the MetadataDate property value

public DateType

Returns:

the MetadataDate property
getMetadataDateProperty()

Get the MetadataDate property

public Calendar
getModifierDate()

public DateType
getModifierDateProperty()

public Calendar

Returns:

the ModifyDate value
getModifyDate()

Get the ModifyDate property value

public DateType

Returns:

the ModifyDate property
getModifyDateProperty()

Get the ModifyDate property

public String

Returns:

the Nickname value
getNickname()

Get the Nickname property value

public TextType

Returns:

the Nickname property
getNicknameProperty()

Get the Nickname property

public Integer

Returns:

the Rating value
getRating()

Get the Rating property value

public IntegerType

Returns:

the Rating property
getRatingProperty()

Get the Rating property

public List<ThumbnailType>

Returns:

List of all thumbnails properties defined
getThumbnailsProperty()

Get list of Thumbnails

public void
removeAdvisory(String xpath)

public void
removeIdentifier(String text)

public void
setBaseURL(String
the Base url value to set
url)

Set the base URL for relative URLs in the document content

public void
setBaseURLProperty(URLType
the Base url property to set
url)

Set the base URL property

public void
setCreateDate(Calendar
the value to set
date)

Set the date and time the resource was originally created

public void
setCreateDateProperty(DateType
the create date property to set
date)

Set the create date property

public void
setCreatorTool(String
the creator tool value to set
creatorTool)

set the name of the first known tool used to create this resource

public void
setCreatorToolProperty(AgentNameType
the creator tool property to set
creatorTool)

set the creatorTool property

public void
setLabel(String
the label value to set
text)

set a word or a short phrase which identifies a document as a member of a user-defined collection

public void
setLabelProperty(TextType
the label property to set
text)

set the label property

public void
setMetadataDate(Calendar
the Metadata Date value to set
date)

Set the date and time that any metadata for this resource was last changed.

public void
setMetadataDateProperty(DateType
the Metadata Date property to set
date)

Set the MetadataDate property

public void
setModifierDate(Calendar date)

public void
setModifierDateProperty(DateType date)

public void
setModifyDate(Calendar
the Modify Date value to set
date)

Set the date and time the resource was last modified

public void
setModifyDateProperty(DateType
the Modify Date property to set
date)

Set the ModifyDate property

public void
setNickname(String
the Nickname value to set
text)

Set a short informal name for the resource

public void
setNicknameProperty(TextType
the Nickname property to set
text)

Set the NickName property

public void
setRating(Integer
the rate value to set
rate)

Set a number that indicates a document's status relative to other documents, used to organize documents in a file browser (values are user-defined within an application-defined range)

public void
setRatingProperty(IntegerType
the rate property to set
rate)

Set Rating Property

Inherited from org.apache.xmpbox.schema.XMPSchema:
addBagValueaddBagValueAsSimpleaddQualifiedBagValueaddSequenceDateValueAsSimpleaddUnqualifiedSequenceDateValueaddUnqualifiedSequenceValueaddUnqualifiedSequenceValuegetAboutAttributegetAboutValuegetAbstractPropertygetBooleanPropertygetBooleanPropertyValuegetBooleanPropertyValueAsSimplegetDatePropertygetDatePropertyValuegetDatePropertyValueAsSimplegetIntegerPropertygetIntegerPropertyValuegetIntegerPropertyValueAsSimplegetUnqualifiedArrayListgetUnqualifiedBagValueListgetUnqualifiedLanguagePropertyLanguagesValuegetUnqualifiedLanguagePropertyValuegetUnqualifiedSequenceDateValueListgetUnqualifiedSequenceValueListgetUnqualifiedTextPropertygetUnqualifiedTextPropertyValueinstanciateSimplemergeremoveUnqualifiedArrayValueremoveUnqualifiedBagValueremoveUnqualifiedSequenceDateValueremoveUnqualifiedSequenceValueremoveUnqualifiedSequenceValuereorganizeAltOrdersetAboutsetAboutAsSimplesetBooleanPropertysetBooleanPropertyValuesetBooleanPropertyValueAsSimplesetDatePropertysetDatePropertyValuesetDatePropertyValueAsSimplesetIntegerPropertysetIntegerPropertyValuesetIntegerPropertyValueAsSimplesetTextPropertysetTextPropertyValuesetTextPropertyValueAsSimplesetUnqualifiedLanguagePropertyValue

Field Detail

ADVISORYback to summary
public static final String ADVISORY
Annotations
@PropertyType
type:XPath
card:Bag
altThumbsback to summary
private ArrayProperty altThumbs
BASEURLback to summary
public static final String BASEURL
Annotations
@PropertyType
type:URL
card:Simple
CREATEDATEback to summary
public static final String CREATEDATE
Annotations
@PropertyType
type:Date
card:Simple
CREATORTOOLback to summary
public static final String CREATORTOOL
Annotations
@PropertyType
type:AgentName
card:Simple
IDENTIFIERback to summary
public static final String IDENTIFIER
Annotations
@PropertyType
type:Text
card:Bag
LABELback to summary
public static final String LABEL
Annotations
@PropertyType
type:Text
card:Simple
METADATADATEback to summary
public static final String METADATADATE
Annotations
@PropertyType
type:Date
card:Simple
MODIFIER_DATEback to summary
public static final String MODIFIER_DATE
Annotations
@PropertyType
type:Date
card:Simple
MODIFYDATEback to summary
public static final String MODIFYDATE
Annotations
@PropertyType
type:Date
card:Simple
NICKNAMEback to summary
public static final String NICKNAME
Annotations
@PropertyType
type:Text
card:Simple
RATINGback to summary
public static final String RATING
Annotations
@PropertyType
type:Integer
card:Simple
THUMBNAILSback to summary
public static final String THUMBNAILS
Annotations
@PropertyType
type:Thumbnail
card:Alt

Constructor Detail

XMPBasicSchemaback to summary
public XMPBasicSchema(XMPMetadata metadata)

Constructor of XMPBasic schema with preferred prefix

Parameters
metadata:XMPMetadata

The metadata to attach this schema

XMPBasicSchemaback to summary
public XMPBasicSchema(XMPMetadata metadata, String ownPrefix)

Constructor of XMPBasic schema with specified prefix

Parameters
metadata:XMPMetadata

The metadata to attach this schema

ownPrefix:String

The prefix to assign

Method Detail

addAdvisoryback to summary
public void addAdvisory(String xpath)

Add a property specification that were edited outside the authoring application

Parameters
xpath:String

the value to add

addIdentifierback to summary
public void addIdentifier(String text)

Add a text string which unambiguously identify the resource within a given context

Parameters
text:String

the identifier value to add

addThumbnailsback to summary
public void addThumbnails(Integer height, Integer width, String format, String img)

Add thumbnail to thumbnails list

Parameters
height:Integer

height format

width:Integer

width format

format:String

thumbnail format

img:String

Image data

getAdvisoryback to summary
public List<String> getAdvisory()

Get the Advisory property values

Returns:List<String>

list of adivory values

getAdvisoryPropertyback to summary
public ArrayProperty getAdvisoryProperty()

Get the Advisory property

Returns:ArrayProperty

the advisory property

getBaseURLback to summary
public String getBaseURL()

Get the BaseURL property value

Returns:String

the base url value

getBaseURLPropertyback to summary
public TextType getBaseURLProperty()

Get the BaseURL property

Returns:TextType

the base url property

getCreateDateback to summary
public Calendar getCreateDate()

Get the CreateDate property value

Returns:Calendar

the CreateDate value

getCreateDatePropertyback to summary
public DateType getCreateDateProperty()

Get the CreateDate property

Returns:DateType

the CreateDate property

getCreatorToolback to summary
public String getCreatorTool()

Get the CreationTool property value

Returns:String

the CreationTool value

getCreatorToolPropertyback to summary
public TextType getCreatorToolProperty()

Get the CreationTool property

Returns:TextType

the CreationTool property

getIdentifiersback to summary
public List<String> getIdentifiers()

Get the Identifier property values

Returns:List<String>

list of all identifier values

getIdentifiersPropertyback to summary
public ArrayProperty getIdentifiersProperty()

Get the Identifier property

Returns:ArrayProperty

the Identifier property

getLabelback to summary
public String getLabel()

Get the label property value

Returns:String

the label value

getLabelPropertyback to summary
public TextType getLabelProperty()

Get the label property

Returns:TextType

the label property

getMetadataDateback to summary
public Calendar getMetadataDate()

Get the MetadataDate property value

Returns:Calendar

the MetadataDate value

getMetadataDatePropertyback to summary
public DateType getMetadataDateProperty()

Get the MetadataDate property

Returns:DateType

the MetadataDate property

getModifierDateback to summary
public Calendar getModifierDate()
getModifierDatePropertyback to summary
public DateType getModifierDateProperty()
getModifyDateback to summary
public Calendar getModifyDate()

Get the ModifyDate property value

Returns:Calendar

the ModifyDate value

getModifyDatePropertyback to summary
public DateType getModifyDateProperty()

Get the ModifyDate property

Returns:DateType

the ModifyDate property

getNicknameback to summary
public String getNickname()

Get the Nickname property value

Returns:String

the Nickname value

getNicknamePropertyback to summary
public TextType getNicknameProperty()

Get the Nickname property

Returns:TextType

the Nickname property

getRatingback to summary
public Integer getRating()

Get the Rating property value

Returns:Integer

the Rating value

getRatingPropertyback to summary
public IntegerType getRatingProperty()

Get the Rating property

Returns:IntegerType

the Rating property

getThumbnailsPropertyback to summary
public List<ThumbnailType> getThumbnailsProperty() throws BadFieldValueException

Get list of Thumbnails

Returns:List<ThumbnailType>

List of all thumbnails properties defined

Exceptions
BadFieldValueException:
if one thumbnail is not thumbnail type
removeAdvisoryback to summary
public void removeAdvisory(String xpath)
removeIdentifierback to summary
public void removeIdentifier(String text)
setBaseURLback to summary
public void setBaseURL(String url)

Set the base URL for relative URLs in the document content

Parameters
url:String

the Base url value to set

setBaseURLPropertyback to summary
public void setBaseURLProperty(URLType url)

Set the base URL property

Parameters
url:URLType

the Base url property to set

setCreateDateback to summary
public void setCreateDate(Calendar date)

Set the date and time the resource was originally created

Parameters
date:Calendar

the value to set

setCreateDatePropertyback to summary
public void setCreateDateProperty(DateType date)

Set the create date property

Parameters
date:DateType

the create date property to set

setCreatorToolback to summary
public void setCreatorTool(String creatorTool)

set the name of the first known tool used to create this resource

Parameters
creatorTool:String

the creator tool value to set

setCreatorToolPropertyback to summary
public void setCreatorToolProperty(AgentNameType creatorTool)

set the creatorTool property

Parameters
creatorTool:AgentNameType

the creator tool property to set

setLabelback to summary
public void setLabel(String text)

set a word or a short phrase which identifies a document as a member of a user-defined collection

Parameters
text:String

the label value to set

setLabelPropertyback to summary
public void setLabelProperty(TextType text)

set the label property

Parameters
text:TextType

the label property to set

setMetadataDateback to summary
public void setMetadataDate(Calendar date)

Set the date and time that any metadata for this resource was last changed. (should be equals or more recent than the createDate)

Parameters
date:Calendar

the Metadata Date value to set

setMetadataDatePropertyback to summary
public void setMetadataDateProperty(DateType date)

Set the MetadataDate property

Parameters
date:DateType

the Metadata Date property to set

setModifierDateback to summary
public void setModifierDate(Calendar date)
setModifierDatePropertyback to summary
public void setModifierDateProperty(DateType date)
setModifyDateback to summary
public void setModifyDate(Calendar date)

Set the date and time the resource was last modified

Parameters
date:Calendar

the Modify Date value to set

setModifyDatePropertyback to summary
public void setModifyDateProperty(DateType date)

Set the ModifyDate property

Parameters
date:DateType

the Modify Date property to set

setNicknameback to summary
public void setNickname(String text)

Set a short informal name for the resource

Parameters
text:String

the Nickname value to set

setNicknamePropertyback to summary
public void setNicknameProperty(TextType text)

Set the NickName property

Parameters
text:TextType

the Nickname property to set

setRatingback to summary
public void setRating(Integer rate)

Set a number that indicates a document's status relative to other documents, used to organize documents in a file browser (values are user-defined within an application-defined range)

Parameters
rate:Integer

the rate value to set

setRatingPropertyback to summary
public void setRatingProperty(IntegerType rate)

Set Rating Property

Parameters
rate:IntegerType

the rate property to set