Package org.apache.tika.metadata
Class Property
- java.lang.Object
-
- org.apache.tika.metadata.Property
-
- All Implemented Interfaces:
Comparable<Property>
public final class Property extends Object implements Comparable<Property>
XMP property definition. Each instance of this class defines a single metadata property like "dc:format". In addition to the property name, thevalue type
and category (internal or external) of the property are included in the property definition. The available choice values are also stored for open and closed choice value types.- Since:
- Apache Tika 0.7
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Property.PropertyType
static class
Property.ValueType
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description int
compareTo(Property o)
static Property
composite(Property primaryProperty, Property[] secondaryExtractProperties)
Constructs a new composite property from the given primary and array of secondary properties.boolean
equals(Object o)
static Property
externalBoolean(String name)
static Property
externalBooleanSeq(String name)
static Property
externalClosedChoise(String name, String... choices)
static Property
externalDate(String name)
static Property
externalInteger(String name)
static Property
externalOpenChoise(String name, String... choices)
static Property
externalReal(String name)
static Property
externalRealSeq(String name)
static Property
externalText(String name)
static Property
externalTextBag(String name)
static Property
get(String key)
Retrieve the property object that corresponds to the given keySet<String>
getChoices()
Returns the (immutable) set of choices for the values of this property.String
getName()
Property
getPrimaryProperty()
Gets the primary property for a composite propertystatic SortedSet<Property>
getProperties(String prefix)
Property.PropertyType
getPropertyType()
static Property.PropertyType
getPropertyType(String key)
Get the type of a propertyProperty[]
getSecondaryExtractProperties()
Gets the secondary properties for a composite propertyProperty.ValueType
getValueType()
int
hashCode()
static Property
internalBoolean(String name)
static Property
internalClosedChoise(String name, String... choices)
static Property
internalDate(String name)
static Property
internalDateBag(String name)
static Property
internalInteger(String name)
static Property
internalIntegerSequence(String name)
static Property
internalOpenChoise(String name, String... choices)
static Property
internalRational(String name)
static Property
internalReal(String name)
static Property
internalText(String name)
static Property
internalTextBag(String name)
static Property
internalURI(String name)
boolean
isExternal()
boolean
isInternal()
boolean
isMultiValuePermitted()
Is the PropertyType one which accepts multiple values?
-
-
-
Method Detail
-
getPropertyType
public static Property.PropertyType getPropertyType(String key)
Get the type of a property- Parameters:
key
- name of the property- Returns:
- the type of the property
-
get
public static Property get(String key)
Retrieve the property object that corresponds to the given key- Parameters:
key
- the property key or name- Returns:
- the Property object
-
composite
public static Property composite(Property primaryProperty, Property[] secondaryExtractProperties)
Constructs a new composite property from the given primary and array of secondary properties.Note that name of the composite property is taken from its primary property, and primary and secondary properties must not be composite properties themselves.
- Parameters:
primaryProperty
-secondaryExtractProperties
-- Returns:
- the composite property
-
getName
public String getName()
-
isInternal
public boolean isInternal()
-
isExternal
public boolean isExternal()
-
isMultiValuePermitted
public boolean isMultiValuePermitted()
Is the PropertyType one which accepts multiple values?
-
getPropertyType
public Property.PropertyType getPropertyType()
-
getValueType
public Property.ValueType getValueType()
-
getChoices
public Set<String> getChoices()
Returns the (immutable) set of choices for the values of this property. Only defined foropen
andclosed choice
value types.- Returns:
- available choices, or
null
-
getPrimaryProperty
public Property getPrimaryProperty()
Gets the primary property for a composite property- Returns:
- the primary property
-
getSecondaryExtractProperties
public Property[] getSecondaryExtractProperties()
Gets the secondary properties for a composite property- Returns:
- the secondary properties
-
compareTo
public int compareTo(Property o)
- Specified by:
compareTo
in interfaceComparable<Property>
-
-