de.umr.jepc

Class Attribute

java.lang.Object

de.umr.jepc.Attribute

All Implemented Interfaces:

java.io.Serializable, xxl.core.io.Convertable

public class Attribute
extends java.lang.Object
implements xxl.core.io.Convertable

An attribute represents a single element of a schema. It consists of a name (unique within a schema), a type and a set of properties.

Author:

Bastian Hoßbach

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Attribute.DataType JEPC data types

Constructor Summary

Constructors

Constructor and Description
Attribute() Empty constructor for deserialization
Attribute(Attribute attribute) Copy constructor.
Attribute(java.lang.String attributeName, Attribute.DataType attributeType) Creates a new attribute.

Method Summary

Modifier and Type	Method and Description
void	clearProperties() Removes all properties completely.
Attribute	copy() Copies this attribute.
boolean	equals(java.lang.Object o)
java.lang.String	getAttributeName() Gets the name of the attribute.
Attribute.DataType	getAttributeType() Gets the data type of the attribute.
java.lang.Number	getMaximumValue() Returns the maximum value of this attribute.
int	getMaxStringSize() Returns the maximum string size of this attribute.
java.lang.Number	getMinimumValue() Returns the minimum value of this attribute.
java.lang.String	getProducerType() Gets the type of the schema of this attribute.
java.util.Map<java.lang.String,java.lang.String>	getProperties() Gets all properties of the attribute.
java.lang.String	getProperty(java.lang.String key) Gets the value of a property for a given key.
java.lang.String	getStaticValue() Gets the static value of this attribute.
java.util.List<java.lang.String>	getValueList() Returns a list containing all allowed values for this specific attribute.
boolean	isKey() Returns true if this attribute is part of the key and false otherwise.
boolean	isNumeric() Returns true if the type of this attribute is numeric and false otherwise.
boolean	isUnique() Returns true if this attribute is unique and false otherwise.
java.util.Set<java.lang.String>	propertyNames() Gets the set of keys of all properties.
void	read(java.io.DataInput dataInput)
java.lang.String	removeProperty(java.lang.String key) Removes a property completely.
void	setAttributeName(java.lang.String attributeName) Sets the name of the attribute.
void	setAttributeType(Attribute.DataType attributeType) Sets the data type of the attribute.
Attribute	setIsKey() Sets the attribute to be part of the key of the corresponding schema.
Attribute	setIsUnique() Sets the attribute to be unique.
Attribute	setMaximumValue(java.lang.Number value) Sets the maximum value for this attribute.
Attribute	setMaxStringSize(int maxStringSize) Sets the maximum string size for this attribute.
Attribute	setMinimumValue(java.lang.Number value) Sets the minimum value for this attribute.
Attribute	setProducerType(java.lang.String producerType) Sets the type for the schema of this attribute.
Attribute	setProperty(java.lang.String key, java.lang.String value) Sets a property.
Attribute	setStaticValue(java.lang.Object value) Sets a static value for the attribute.
void	setValueList(java.util.List<java.lang.String> values) Defines a list of restrictive values for this attribute.
java.lang.String	toString()
Attribute	unsetIsKey() Unsets the attribute to be part of the key of the corresponding schema.
Attribute	unsetIsUnique() Unsets the attribute to be unique.
Attribute	unsetProducerType() Unsets the type for the schema of this attribute.
Attribute	unsetStaticValue() Unsets the static value of the attribute.
void	write(java.io.DataOutput dataOutput)

Methods inherited from class java.lang.Object

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

Constructor Detail

Attribute

public Attribute(java.lang.String attributeName,
                 Attribute.DataType attributeType)

Creates a new attribute.

Parameters:

attributeName - the name of the attribute

attributeType - the JEPC data type of the attribute

Attribute

public Attribute(Attribute attribute)

Copy constructor.

Parameters:

attribute - the attribute to copy

Attribute

public Attribute()

Empty constructor for deserialization

Method Detail

copy

public Attribute copy()

Copies this attribute.

Returns:

a copy of this attribute

getAttributeName

public java.lang.String getAttributeName()

Gets the name of the attribute.

Returns:

the name of the attribute

setAttributeName

public void setAttributeName(java.lang.String attributeName)

Sets the name of the attribute.

Parameters:

attributeName - new name of the attribute

getAttributeType

public Attribute.DataType getAttributeType()

Gets the data type of the attribute.

Returns:

the data type of the attribute

setAttributeType

public void setAttributeType(Attribute.DataType attributeType)

Sets the data type of the attribute.

Parameters:

attributeType - new data type of the attribute

getProperties

public java.util.Map<java.lang.String,java.lang.String> getProperties()

Gets all properties of the attribute.

Returns:

all properties of the attribute

setMaxStringSize

public Attribute setMaxStringSize(int maxStringSize)

Sets the maximum string size for this attribute. The string size is measured in number of characters.

Parameters:

maxStringSize - the maximum string size in number of characters

getMaxStringSize

public int getMaxStringSize()

Returns the maximum string size of this attribute. The string size is measured in number of characters.

Returns:

the maximum string size in number of characters

setProducerType

public Attribute setProducerType(java.lang.String producerType)

Sets the type for the schema of this attribute.

Parameters:

producerType - the type for the schema of this attribute

Returns:

attribute with set type

unsetProducerType

public Attribute unsetProducerType()

Unsets the type for the schema of this attribute.

Returns:

attribute with unset type

getProducerType

public java.lang.String getProducerType()

Gets the type of the schema of this attribute.

Returns:

the type of the schema of this attribute

setMinimumValue

public Attribute setMinimumValue(java.lang.Number value)

Sets the minimum value for this attribute. This property is required for data integrity checking. The property is only valid for numeric attributes. Non-numeric attributes will ignore the passed value.

Parameters:

value - the minimum allowed value.

Returns:

attribute with set minimum value

getMinimumValue

public java.lang.Number getMinimumValue()

Returns the minimum value of this attribute. The value is returned in the required format, i.e. an attribute of type FLOAT returns a float value and so on.

For non-numeric attributes, NULL is returned.

Returns:

the minimum value of this attribute or null, if this attribute is non-numeric

setMaximumValue

public Attribute setMaximumValue(java.lang.Number value)

Sets the maximum value for this attribute. This property is required for data integrity checking. The property is only valid for numeric attributes. Non-numeric attributes will ignore the passed value.

Parameters:

value - the maximum allowed value.

Returns:

attribute with set maximum value

getMaximumValue

public java.lang.Number getMaximumValue()

Returns the maximum value of this attribute. The value is returned in the required format, i.e. an attribute of type FLOAT returns a float value and so on.

For non-numeric attributes, NULL is returned.

Returns:

the maximum value of this attribute or null, if this attribute is non-numeric

setValueList

public void setValueList(java.util.List<java.lang.String> values)

Defines a list of restrictive values for this attribute. These values only map to textual representations. If the corresponding type is numerical, this method has no effect.

Parameters:

values - a list containing permitted values

getValueList

public java.util.List<java.lang.String> getValueList()

Returns a list containing all allowed values for this specific attribute. The attribute has to be textual (i.e. non-numeric), otherwise null is returned.

Returns:

the list of values or null if the attribute is numeric or no value list was defined

propertyNames

public java.util.Set<java.lang.String> propertyNames()

Gets the set of keys of all properties.

Returns:

the set of keys of all properties

setProperty

public Attribute setProperty(java.lang.String key,
                             java.lang.String value)

Sets a property.

Parameters:

key - the key of the property to set

value - the value of the property to set

Returns:

attribute with new or updated property

removeProperty

public java.lang.String removeProperty(java.lang.String key)

Removes a property completely.

Parameters:

key - the key of the property to remove

Returns:

attribute without the specified property

setIsKey

public Attribute setIsKey()

Sets the attribute to be part of the key of the corresponding schema.

Returns:

attribute with key property

unsetIsKey

public Attribute unsetIsKey()

Unsets the attribute to be part of the key of the corresponding schema.

Returns:

attribute without key property

isKey

public boolean isKey()

Returns true if this attribute is part of the key and false otherwise.

Returns:

true if this attribute is part of the key and false otherwise

setIsUnique

public Attribute setIsUnique()

Sets the attribute to be unique. Unique means that this attribute can be used to clearly identify the origin of an event.

Returns:

attribute with unique property

unsetIsUnique

public Attribute unsetIsUnique()

Unsets the attribute to be unique.

Returns:

attribute without unique property

isUnique

public boolean isUnique()

Returns true if this attribute is unique and false otherwise.

Returns:

true if this attribute is unique and false otherwise

isNumeric

public boolean isNumeric()

Returns true if the type of this attribute is numeric and false otherwise.

Returns:

true if this attribute's type is numeric, false otherwise

getProperty

public java.lang.String getProperty(java.lang.String key)

Gets the value of a property for a given key.

Parameters:

key - the key of the property to get the value of

Returns:

value of property with the given key

setStaticValue

public Attribute setStaticValue(java.lang.Object value)

Sets a static value for the attribute. A static value can be given if the values of this attribute are not variable.

Parameters:

value - the static value of this attribute

Returns:

attribute with static value set

unsetStaticValue

public Attribute unsetStaticValue()

Unsets the static value of the attribute.

Returns:

attribute without static value set

getStaticValue

public java.lang.String getStaticValue()

Gets the static value of this attribute.

Returns:

the static value of this attribute

clearProperties

public void clearProperties()

Removes all properties completely.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

read

public void read(java.io.DataInput dataInput)
          throws java.io.IOException

Specified by:

read in interface xxl.core.io.Convertable

Throws:

java.io.IOException

write

public void write(java.io.DataOutput dataOutput)
           throws java.io.IOException

Specified by:

write in interface xxl.core.io.Convertable

Throws:

java.io.IOException