Package org.apache.xmpbox.schema
Class XMPBasicSchema
- 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.XMPBasicSchema
-
public class XMPBasicSchema extends XMPSchema
Representation of XMPBasic Schema
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ADVISORY
private ArrayProperty
altThumbs
static java.lang.String
BASEURL
static java.lang.String
CREATEDATE
static java.lang.String
CREATORTOOL
static java.lang.String
IDENTIFIER
static java.lang.String
LABEL
static java.lang.String
METADATADATE
static java.lang.String
MODIFIER_DATE
static java.lang.String
MODIFYDATE
static java.lang.String
NICKNAME
static java.lang.String
RATING
static java.lang.String
THUMBNAILS
-
Fields inherited from class org.apache.xmpbox.type.AbstractStructuredType
STRUCTURE_ARRAY_NAME
-
-
Constructor Summary
Constructors Constructor Description XMPBasicSchema(XMPMetadata metadata)
Constructor of XMPBasic schema with preferred prefixXMPBasicSchema(XMPMetadata metadata, java.lang.String ownPrefix)
Constructor of XMPBasic schema with specified prefix
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addAdvisory(java.lang.String xpath)
Add a property specification that were edited outside the authoring applicationvoid
addIdentifier(java.lang.String text)
Add a text string which unambiguously identify the resource within a given contextvoid
addThumbnails(java.lang.Integer height, java.lang.Integer width, java.lang.String format, java.lang.String img)
Add thumbnail to thumbnails listjava.util.List<java.lang.String>
getAdvisory()
Get the Advisory property valuesArrayProperty
getAdvisoryProperty()
Get the Advisory propertyjava.lang.String
getBaseURL()
Get the BaseURL property valueTextType
getBaseURLProperty()
Get the BaseURL propertyjava.util.Calendar
getCreateDate()
Get the CreateDate property valueDateType
getCreateDateProperty()
Get the CreateDate propertyjava.lang.String
getCreatorTool()
Get the CreationTool property valueTextType
getCreatorToolProperty()
Get the CreationTool propertyjava.util.List<java.lang.String>
getIdentifiers()
Get the Identifier property valuesArrayProperty
getIdentifiersProperty()
Get the Identifier propertyjava.lang.String
getLabel()
Get the label property valueTextType
getLabelProperty()
Get the label propertyjava.util.Calendar
getMetadataDate()
Get the MetadataDate property valueDateType
getMetadataDateProperty()
Get the MetadataDate propertyjava.util.Calendar
getModifierDate()
DateType
getModifierDateProperty()
java.util.Calendar
getModifyDate()
Get the ModifyDate property valueDateType
getModifyDateProperty()
Get the ModifyDate propertyjava.lang.String
getNickname()
Get the Nickname property valueTextType
getNicknameProperty()
Get the Nickname propertyjava.lang.Integer
getRating()
Get the Rating property valueIntegerType
getRatingProperty()
Get the Rating propertyjava.util.List<ThumbnailType>
getThumbnailsProperty()
Get list of Thumbnailsvoid
removeAdvisory(java.lang.String xpath)
void
removeIdentifier(java.lang.String text)
void
setBaseURL(java.lang.String url)
Set the base URL for relative URLs in the document contentvoid
setBaseURLProperty(URLType url)
Set the base URL propertyvoid
setCreateDate(java.util.Calendar date)
Set the date and time the resource was originally createdvoid
setCreateDateProperty(DateType date)
Set the create date propertyvoid
setCreatorTool(java.lang.String creatorTool)
set the name of the first known tool used to create this resourcevoid
setCreatorToolProperty(AgentNameType creatorTool)
set the creatorTool propertyvoid
setLabel(java.lang.String text)
set a word or a short phrase which identifies a document as a member of a user-defined collectionvoid
setLabelProperty(TextType text)
set the label propertyvoid
setMetadataDate(java.util.Calendar date)
Set the date and time that any metadata for this resource was last changed.void
setMetadataDateProperty(DateType date)
Set the MetadataDate propertyvoid
setModifierDate(java.util.Calendar date)
void
setModifierDateProperty(DateType date)
void
setModifyDate(java.util.Calendar date)
Set the date and time the resource was last modifiedvoid
setModifyDateProperty(DateType date)
Set the ModifyDate propertyvoid
setNickname(java.lang.String text)
Set a short informal name for the resourcevoid
setNicknameProperty(TextType text)
Set the NickName propertyvoid
setRating(java.lang.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)void
setRatingProperty(IntegerType rate)
Set Rating Property-
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
-
-
-
-
Field Detail
-
ADVISORY
public static final java.lang.String ADVISORY
- See Also:
- Constant Field Values
-
BASEURL
public static final java.lang.String BASEURL
- See Also:
- Constant Field Values
-
CREATEDATE
public static final java.lang.String CREATEDATE
- See Also:
- Constant Field Values
-
CREATORTOOL
public static final java.lang.String CREATORTOOL
- See Also:
- Constant Field Values
-
IDENTIFIER
public static final java.lang.String IDENTIFIER
- See Also:
- Constant Field Values
-
LABEL
public static final java.lang.String LABEL
- See Also:
- Constant Field Values
-
METADATADATE
public static final java.lang.String METADATADATE
- See Also:
- Constant Field Values
-
MODIFYDATE
public static final java.lang.String MODIFYDATE
- See Also:
- Constant Field Values
-
NICKNAME
public static final java.lang.String NICKNAME
- See Also:
- Constant Field Values
-
RATING
public static final java.lang.String RATING
- See Also:
- Constant Field Values
-
THUMBNAILS
public static final java.lang.String THUMBNAILS
- See Also:
- Constant Field Values
-
MODIFIER_DATE
public static final java.lang.String MODIFIER_DATE
- See Also:
- Constant Field Values
-
altThumbs
private ArrayProperty altThumbs
-
-
Constructor Detail
-
XMPBasicSchema
public XMPBasicSchema(XMPMetadata metadata)
Constructor of XMPBasic schema with preferred prefix- Parameters:
metadata
- The metadata to attach this schema
-
XMPBasicSchema
public XMPBasicSchema(XMPMetadata metadata, java.lang.String ownPrefix)
Constructor of XMPBasic schema with specified prefix- Parameters:
metadata
- The metadata to attach this schemaownPrefix
- The prefix to assign
-
-
Method Detail
-
addThumbnails
public void addThumbnails(java.lang.Integer height, java.lang.Integer width, java.lang.String format, java.lang.String img)
Add thumbnail to thumbnails list- Parameters:
height
- height formatwidth
- width formatformat
- thumbnail formatimg
- Image data
-
addAdvisory
public void addAdvisory(java.lang.String xpath)
Add a property specification that were edited outside the authoring application- Parameters:
xpath
- the value to add
-
removeAdvisory
public void removeAdvisory(java.lang.String xpath)
-
setBaseURL
public void setBaseURL(java.lang.String url)
Set the base URL for relative URLs in the document content- Parameters:
url
- the Base url value to set
-
setBaseURLProperty
public void setBaseURLProperty(URLType url)
Set the base URL property- Parameters:
url
- the Base url property to set
-
setCreateDate
public void setCreateDate(java.util.Calendar date)
Set the date and time the resource was originally created- Parameters:
date
- the value to set
-
setCreateDateProperty
public void setCreateDateProperty(DateType date)
Set the create date property- Parameters:
date
- the create date property to set
-
setCreatorTool
public void setCreatorTool(java.lang.String creatorTool)
set the name of the first known tool used to create this resource- Parameters:
creatorTool
- the creator tool value to set
-
setCreatorToolProperty
public void setCreatorToolProperty(AgentNameType creatorTool)
set the creatorTool property- Parameters:
creatorTool
- the creator tool property to set
-
addIdentifier
public void addIdentifier(java.lang.String text)
Add a text string which unambiguously identify the resource within a given context- Parameters:
text
- the identifier value to add
-
removeIdentifier
public void removeIdentifier(java.lang.String text)
-
setLabel
public void setLabel(java.lang.String text)
set a word or a short phrase which identifies a document as a member of a user-defined collection- Parameters:
text
- the label value to set
-
setLabelProperty
public void setLabelProperty(TextType text)
set the label property- Parameters:
text
- the label property to set
-
setMetadataDate
public void setMetadataDate(java.util.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
- the Metadata Date value to set
-
setMetadataDateProperty
public void setMetadataDateProperty(DateType date)
Set the MetadataDate property- Parameters:
date
- the Metadata Date property to set
-
setModifyDate
public void setModifyDate(java.util.Calendar date)
Set the date and time the resource was last modified- Parameters:
date
- the Modify Date value to set
-
setModifierDate
public void setModifierDate(java.util.Calendar date)
-
setModifyDateProperty
public void setModifyDateProperty(DateType date)
Set the ModifyDate property- Parameters:
date
- the Modify Date property to set
-
setModifierDateProperty
public void setModifierDateProperty(DateType date)
-
setNickname
public void setNickname(java.lang.String text)
Set a short informal name for the resource- Parameters:
text
- the Nickname value to set
-
setNicknameProperty
public void setNicknameProperty(TextType text)
Set the NickName property- Parameters:
text
- the Nickname property to set
-
setRating
public void setRating(java.lang.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
- the rate value to set
-
setRatingProperty
public void setRatingProperty(IntegerType rate)
Set Rating Property- Parameters:
rate
- the rate property to set
-
getAdvisoryProperty
public ArrayProperty getAdvisoryProperty()
Get the Advisory property- Returns:
- the advisory property
-
getAdvisory
public java.util.List<java.lang.String> getAdvisory()
Get the Advisory property values- Returns:
- list of adivory values
-
getBaseURLProperty
public TextType getBaseURLProperty()
Get the BaseURL property- Returns:
- the base url property
-
getBaseURL
public java.lang.String getBaseURL()
Get the BaseURL property value- Returns:
- the base url value
-
getCreateDateProperty
public DateType getCreateDateProperty()
Get the CreateDate property- Returns:
- the CreateDate property
-
getCreateDate
public java.util.Calendar getCreateDate()
Get the CreateDate property value- Returns:
- the CreateDate value
-
getCreatorToolProperty
public TextType getCreatorToolProperty()
Get the CreationTool property- Returns:
- the CreationTool property
-
getCreatorTool
public java.lang.String getCreatorTool()
Get the CreationTool property value- Returns:
- the CreationTool value
-
getIdentifiersProperty
public ArrayProperty getIdentifiersProperty()
Get the Identifier property- Returns:
- the Identifier property
-
getIdentifiers
public java.util.List<java.lang.String> getIdentifiers()
Get the Identifier property values- Returns:
- list of all identifier values
-
getLabelProperty
public TextType getLabelProperty()
Get the label property- Returns:
- the label property
-
getLabel
public java.lang.String getLabel()
Get the label property value- Returns:
- the label value
-
getMetadataDateProperty
public DateType getMetadataDateProperty()
Get the MetadataDate property- Returns:
- the MetadataDate property
-
getMetadataDate
public java.util.Calendar getMetadataDate()
Get the MetadataDate property value- Returns:
- the MetadataDate value
-
getModifyDateProperty
public DateType getModifyDateProperty()
Get the ModifyDate property- Returns:
- the ModifyDate property
-
getModifierDateProperty
public DateType getModifierDateProperty()
-
getModifyDate
public java.util.Calendar getModifyDate()
Get the ModifyDate property value- Returns:
- the ModifyDate value
-
getModifierDate
public java.util.Calendar getModifierDate()
-
getNicknameProperty
public TextType getNicknameProperty()
Get the Nickname property- Returns:
- the Nickname property
-
getNickname
public java.lang.String getNickname()
Get the Nickname property value- Returns:
- the Nickname value
-
getRatingProperty
public IntegerType getRatingProperty()
Get the Rating property- Returns:
- the Rating property
-
getRating
public java.lang.Integer getRating()
Get the Rating property value- Returns:
- the Rating value
-
getThumbnailsProperty
public java.util.List<ThumbnailType> getThumbnailsProperty() throws BadFieldValueException
Get list of Thumbnails- Returns:
- List of all thumbnails properties defined
- Throws:
BadFieldValueException
- if one thumbnail is not thumbnail type
-
-