cz.cuni.versatile.api
Interface Property

All Known Subinterfaces:
ControlledVocabulary, Equivalence, OrderProperty, RelationalProperty, Taxonomy, TreeTaxonomy

public interface Property

A meta-data property interface. This interface defines the essential attributes common to all Versatile properties. Custom properties can be introduced:

Author:
jgergic

Method Summary
 java.lang.String getLocalName()
          A local property name within a particular namespace.
 java.lang.String getNamespace()
          A property namespace.
 java.lang.String getSeparator()
          Namespace separator.
 java.lang.Class getType()
          A type which is used to represent values of the property.
 java.lang.String getUniqueName()
          A fully qualified property name.
 

Method Detail

getNamespace

public java.lang.String getNamespace()
A property namespace. The namespace can be an arbitrary string, however, it is highly recommended to follow one of the established naming schemas like XML Namespaces (URLs) or Java package names.

Returns:
property namespace
See Also:
Namespaces in XML, Package Names (Java Language Specification)

getLocalName

public java.lang.String getLocalName()
A local property name within a particular namespace.

Returns:
locally unique property name

getUniqueName

public java.lang.String getUniqueName()
A fully qualified property name. Equivalent to invoking: getNamespace() + getSeparator() + getLocalName()

Returns:
fully qualified property name.

getSeparator

public java.lang.String getSeparator()
Namespace separator. A string used to separate namespace and local name when generating fully qualified name. For example '.' (dot) in case of following Java naming conventions, '#' in case of following XML naming conventions:

Returns:
separator between the namespace and the locale name.

getType

public java.lang.Class getType()
A type which is used to represent values of the property. All actual property values must be instances of that type. Can be one of the built-in Java types like java.lang.String, java.lang.Integer, java.lang.Boolean or can be any other custom type, e.g. javax.ccpp.uaprof.DimensionAttribute.

Returns:
class object representing the type of the property.