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

public abstract Class AbstractField

extends Object
Class Inheritance
Known Direct Subclasses
org.apache.xmpbox.type.AbstractSimpleProperty, org.apache.xmpbox.type.AbstractComplexProperty
Imports
java.util.ArrayList, .HashMap, .List, .Map, org.apache.xmpbox.XMPMetadata
Abstract Object representation of a XMP 'field' (-> Properties and specific Schemas)
Author
a183132

Field Summary

Modifier and TypeField and Description
private final Map<String, Attribute>
attributes

private final XMPMetadata
metadata

private String
propertyName

Constructor Summary

AccessConstructor and Description
public
AbstractField(XMPMetadata
The metadata to attach to this field
metadata, String
the local name to set for this field
propertyName)

Constructor of a XMP Field

Method Summary

Modifier and TypeMethod and Description
public final boolean

Returns:

true if attribute is present
containsAttribute(String
the full qualified name of the attribute concerned
qualifiedName)

Check if an attribute is declared for this entity

public final List<Attribute>

Returns:

Attributes list
getAllAttributes()

Get attributes list defined for this entity

public final Attribute

Returns:

The attribute property
getAttribute(String
the full qualified name of the attribute wanted
qualifiedName)

Get an attribute with its name in this entity

public final XMPMetadata
getMetadata()

public abstract String
getNamespace()

public abstract String

Returns:

the prefix specified
getPrefix()

Get the prefix of this entity

public final String

Returns:

the local Name
getPropertyName()

Get the propertyName (or localName)

public final void
removeAttribute(String
the full qualified name of the attribute wanted
qualifiedName)

Remove an attribute of this entity

public final void
setAttribute(Attribute
The Attribute property to add
value)

Set a new attribute for this entity

public final void
setPropertyName(String value)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

attributesback to summary
private final Map<String, Attribute> attributes
metadataback to summary
private final XMPMetadata metadata
propertyNameback to summary
private String propertyName

Constructor Detail

AbstractFieldback to summary
public AbstractField(XMPMetadata metadata, String propertyName)

Constructor of a XMP Field

Parameters
metadata:XMPMetadata

The metadata to attach to this field

propertyName:String

the local name to set for this field

Method Detail

containsAttributeback to summary
public final boolean containsAttribute(String qualifiedName)

Check if an attribute is declared for this entity

Parameters
qualifiedName:String

the full qualified name of the attribute concerned

Returns:boolean

true if attribute is present

getAllAttributesback to summary
public final List<Attribute> getAllAttributes()

Get attributes list defined for this entity

Returns:List<Attribute>

Attributes list

getAttributeback to summary
public final Attribute getAttribute(String qualifiedName)

Get an attribute with its name in this entity

Parameters
qualifiedName:String

the full qualified name of the attribute wanted

Returns:Attribute

The attribute property

getMetadataback to summary
public final XMPMetadata getMetadata()
getNamespaceback to summary
public abstract String getNamespace()
getPrefixback to summary
public abstract String getPrefix()

Get the prefix of this entity

Returns:String

the prefix specified

getPropertyNameback to summary
public final String getPropertyName()

Get the propertyName (or localName)

Returns:String

the local Name

removeAttributeback to summary
public final void removeAttribute(String qualifiedName)

Remove an attribute of this entity

Parameters
qualifiedName:String

the full qualified name of the attribute wanted

setAttributeback to summary
public final void setAttribute(Attribute value)

Set a new attribute for this entity

Parameters
value:Attribute

The Attribute property to add

setPropertyNameback to summary
public final void setPropertyName(String value)