com.exalead.datamodel.v10

Class Property

java.lang.Object

com.exalead.datamodel.v10.Property

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

Direct Known Subclasses:

DataProperty, EnumProperty, ObjectProperty

public abstract class Property
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable

Configuration of a property
Each property belongs to a DataModelClass.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Property.Arity
static class	Property.Tags

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	arity
static java.lang.String	ARITY_MANY
static java.lang.String	ARITY_ONE
static java.lang.String	ARITY_ZERO_OR_ONE
java.lang.String	comment
static java.lang.String	DEFAULT_ARITY
java.util.List<KeyValue>	keyValue
java.util.List<Label>	label
java.lang.String	name
protected Property.Tags	tags

Constructor Summary

Constructors

Constructor and Description
Property()
Property(Property o) Copy constructor
Property(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
void	addKeyValue(java.lang.String key, java.lang.String value)
void	check(boolean deep, java.lang.String errorContext) Checks this Property.
static Property	fromString(java.lang.String s) String representation of this Property.
java.lang.String	getArity() The arity of the property (zero_or_one, one, many) enum(zero_or_one, one, many)
Property.Arity	getArityAsEnum() The arity of the property (zero_or_one, one, many) enum(zero_or_one, one, many)
java.lang.String	getComment() Optional comment to explain property use.
java.util.List<KeyValue>	getKeyValue()
java.util.List<Label>	getLabel() Labels for the internationalization of this property's name
java.lang.String	getName() Property name
Property.Tags	getTags()
static boolean	isA(java.lang.String str, Property.Arity item)
static boolean	isOneOf(java.lang.String str, Property.Arity... items)
Property	makeCopy()
static Property	readFrom(java.io.InputStream is) Read this Property from an XML fragment.
void	setArity(Property.Arity item) The arity of the property (zero_or_one, one, many) enum(zero_or_one, one, many)
void	setArity(java.lang.String arity) The arity of the property (zero_or_one, one, many) enum(zero_or_one, one, many)
void	setComment(java.lang.String comment) Optional comment to explain property use.
void	setName(java.lang.String name) Property name
void	setTags(Property.Tags __value)
java.lang.String	toString() String representation of this Property.
Property	withArity(java.lang.String arity)
Property	withComment(java.lang.String comment)
Property	withKeyValue(java.util.Collection<KeyValue> __values)
Property	withKeyValue(KeyValue... __values)
Property	withLabel(java.util.Collection<Label> __values)
Property	withLabel(Label... __values) Labels for the internationalization of this property's name
Property	withName(java.lang.String name)
Property	withTags(java.util.Collection<KeyValue> __values)
Property	withTags(KeyValue... __values)
Property	withTags(Property.Tags __value)
void	writeTo(java.io.OutputStream os)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

keyValue

public java.util.List<KeyValue> keyValue

arity

public java.lang.String arity

DEFAULT_ARITY

public static final java.lang.String DEFAULT_ARITY

See Also:

Constant Field Values

name

public java.lang.String name

comment

public java.lang.String comment

label

public java.util.List<Label> label

tags

protected Property.Tags tags

ARITY_MANY

public static final java.lang.String ARITY_MANY

See Also:

Constant Field Values

ARITY_ONE

public static final java.lang.String ARITY_ONE

See Also:

Constant Field Values

ARITY_ZERO_OR_ONE

public static final java.lang.String ARITY_ZERO_OR_ONE

See Also:

Constant Field Values

Constructor Detail

Property

public Property()

Property

public Property(Property o)

Copy constructor

Property

public Property(java.lang.String name)

Method Detail

isA

public static boolean isA(java.lang.String str,
                          Property.Arity item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              Property.Arity... items)

setArity

public void setArity(Property.Arity item)

The arity of the property (zero_or_one, one, many)
enum(zero_or_one, one, many)

getArityAsEnum

public Property.Arity getArityAsEnum()

The arity of the property (zero_or_one, one, many)
enum(zero_or_one, one, many)

getKeyValue

public java.util.List<KeyValue> getKeyValue()

withKeyValue

public Property withKeyValue(KeyValue... __values)

withKeyValue

public Property withKeyValue(java.util.Collection<KeyValue> __values)

setArity

public void setArity(java.lang.String arity)

The arity of the property (zero_or_one, one, many)
enum(zero_or_one, one, many)

getArity

public java.lang.String getArity()

The arity of the property (zero_or_one, one, many)
enum(zero_or_one, one, many)

withArity

public Property withArity(java.lang.String arity)

setName

public void setName(java.lang.String name)

Property name

getName

public java.lang.String getName()

Property name

withName

public Property withName(java.lang.String name)

setComment

public void setComment(java.lang.String comment)

Optional comment to explain property use.

getComment

public java.lang.String getComment()

Optional comment to explain property use.

withComment

public Property withComment(java.lang.String comment)

getLabel

public java.util.List<Label> getLabel()

Labels for the internationalization of this property's name

withLabel

public Property withLabel(Label... __values)

Labels for the internationalization of this property's name

withLabel

public Property withLabel(java.util.Collection<Label> __values)

getTags

public Property.Tags getTags()

setTags

public void setTags(Property.Tags __value)

withTags

public Property withTags(KeyValue... __values)

withTags

public Property withTags(java.util.Collection<KeyValue> __values)

withTags

public Property withTags(Property.Tags __value)

makeCopy

public Property makeCopy()

readFrom

public static Property readFrom(java.io.InputStream is)
                         throws javax.xml.bind.JAXBException

Read this Property from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static Property fromString(java.lang.String s)
                           throws javax.xml.bind.JAXBException,
                                  java.io.UnsupportedEncodingException

String representation of this Property.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this Property.

Overrides:

toString in class java.lang.Object

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this Property.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException

addKeyValue

public void addKeyValue(java.lang.String key,
                        java.lang.String value)