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