com.kheops.jmap.metadata

Class Attribute

java.lang.Object

com.kheops.jmap.metadata.LocalizedObject

com.kheops.jmap.metadata.Attribute

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<Attribute>

Direct Known Subclasses:

AttributeRestricted, ExternalAttribute, LinkedAttribute, OgrReader.OgrAttribute

public class Attribute
extends LocalizedObject
implements java.io.Serializable, java.lang.Comparable<Attribute>, java.lang.Cloneable

This class encapsulates information about an attribute field.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	readOnly Indicates whether the attribute is read only

Constructor Summary

Constructors

Constructor and Description
Attribute()
Attribute(Attribute attribute) Creates a new Attribute instance based on the specified attribute, cloning all properties.
Attribute(java.lang.String name, int type) Creates an Attribute instance with the specified parameters.
Attribute(java.lang.String name, java.lang.String title, int type) Creates an Attribute instance with the specified parameters.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Returns a deep copy of the current instance.
int	compareTo(Attribute attribute) Compares the current instance to the specified attribute.
boolean	equals(java.lang.Object o) Overrides the equals method to compare the attribute names.
AttributeStat	getAttributeStat() Returns the statistics of the attribute.
java.lang.String	getFormatPattern() Returns the format pattern for numeric and date types.
java.lang.String	getName() Returns the name of the attribute.
java.lang.String	getTitle() Gets the title of the attribute.
java.lang.String	getTitle(java.util.Locale locale) Gets the title of the attribute for a specific locale.
int	getType() Gets the type of the attribute.
int	hashCode()
boolean	isIndexed() Returns whether or not this attribute is indexed.
boolean	isNullable() Returns true if this attribute supports null values.
boolean	isReadOnly() If the attribute is read only
void	removeTranslationsOtherThan(java.util.Locale[] locales) Removes any Locale from this object that are not in the specified locales.
void	setAttributeStat(AttributeStat stat) Sets the statistics of the Attribute.
void	setFormatPattern(java.lang.String formatPattern) Sets the format pattern for numeric and date types Numeric: DecimalFormat Date: SimpleDateFormat
void	setIndexed(boolean indexed) Sets if this attribute is indexed of not.
void	setName(java.lang.String name) Sets the name of the attribute.
void	setNullable(boolean nullable) Sets if this attribute supports null values.
void	setReadOnly(boolean readOnly) Determines if the attribute is read only
void	setTitle(java.lang.String title) Sets the title of the attribute.
void	setTitle(java.lang.String title, java.util.Locale locale) Sets the title of the attribute for the specified Locale.
void	setType(int type) Sets the type of the attribute.
java.lang.String	toString()

Methods inherited from class com.kheops.jmap.metadata.LocalizedObject

getAvailableLocales, getTranslation, isTranslationExists, setTranslation, updateTranslations

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

readOnly

protected boolean readOnly

Indicates whether the attribute is read only

Constructor Detail

Attribute

public Attribute()

Attribute

public Attribute(java.lang.String name,
                 int type)

Creates an Attribute instance with the specified parameters.

Parameters:

name - the name of the attribute

type - the type of the attribute (uses java.sql.Types constants)

See Also:

Types

Attribute

public Attribute(java.lang.String name,
                 java.lang.String title,
                 int type)

Creates an Attribute instance with the specified parameters.

Parameters:

name - the name of the attribute

title - an optional display name for the attribute

type - the type of the attribute (uses java.sql.Types constants)

See Also:

Types

Attribute

public Attribute(Attribute attribute)

Creates a new Attribute instance based on the specified attribute, cloning all properties.

Parameters:

attribute - the attribute to use as reference.

Method Detail

getName

public java.lang.String getName()

Returns the name of the attribute.

Returns:

name

setName

public void setName(java.lang.String name)

Sets the name of the attribute.

Parameters:

name - the new name of the attribute

getTitle

public java.lang.String getTitle()

Gets the title of the attribute.

Returns:

title.

getTitle

public java.lang.String getTitle(java.util.Locale locale)

Gets the title of the attribute for a specific locale.

Parameters:

locale -

Returns:

title.

setTitle

public void setTitle(java.lang.String title)

Sets the title of the attribute.

Parameters:

title - the new given title.

setTitle

public void setTitle(java.lang.String title,
                     java.util.Locale locale)

Sets the title of the attribute for the specified Locale.

Parameters:

title - the new given title.

locale - the locale for this title

getType

public int getType()

Gets the type of the attribute.

Returns:

type

See Also:

Types

setType

public void setType(int type)

Sets the type of the attribute.

Parameters:

type - the specified type

See Also:

Types

isNullable

public boolean isNullable()

Returns true if this attribute supports null values.

Returns:

whether or not this attribute supports null values.

setNullable

public void setNullable(boolean nullable)

Sets if this attribute supports null values.

Parameters:

nullable - whether or not this attribute supports null values.

getAttributeStat

public AttributeStat getAttributeStat()

Returns the statistics of the attribute. The statistics describe the values for this attribute (min, max, etc.).

Returns:

the associated AttributeStat instance

See Also:

AttributeStat

setAttributeStat

public void setAttributeStat(AttributeStat stat)

Sets the statistics of the Attribute.

Parameters:

stat - the corresponding AttributeStat instance

See Also:

AttributeStat

setIndexed

public void setIndexed(boolean indexed)

Sets if this attribute is indexed of not.

Parameters:

indexed - whether or not this attribute is indexed

isIndexed

public boolean isIndexed()

Returns whether or not this attribute is indexed.

Returns:

whether or not this attribute is indexed.

equals

public boolean equals(java.lang.Object o)

Overrides the equals method to compare the attribute names.

Overrides:

equals in class java.lang.Object

Returns:

true if equal false otherwise.

See Also:

Object.equals(Object o)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

compareTo

public int compareTo(Attribute attribute)

Compares the current instance to the specified attribute. The comparison is made using the attribute name, ignoring the case of both attributes.

Specified by:

compareTo in interface java.lang.Comparable<Attribute>

Parameters:

attribute - the attribute to be compared.

Returns:

0, if both attributes are equals and a negative integer if the current attribute name if lower than the specified attribute. Otherwise, a positive integer is returned.

clone

public java.lang.Object clone()

Returns a deep copy of the current instance.

Overrides:

clone in class java.lang.Object

Returns:

a deep copy of the current instance.

isReadOnly

public boolean isReadOnly()

If the attribute is read only

Returns:

true if the attribute is read only

setReadOnly

public void setReadOnly(boolean readOnly)

Determines if the attribute is read only

Parameters:

readOnly - if attribute is read only

getFormatPattern

public java.lang.String getFormatPattern()

Returns the format pattern for numeric and date types. NULL is returned if there is no format pattern configured. Numeric: DecimalFormat Date: SimpleDateFormat

Returns:

setFormatPattern

public void setFormatPattern(java.lang.String formatPattern)

Sets the format pattern for numeric and date types Numeric: DecimalFormat Date: SimpleDateFormat

Parameters:

formatPattern -

removeTranslationsOtherThan

public void removeTranslationsOtherThan(java.util.Locale[] locales)

Description copied from class: LocalizedObject

Removes any Locale from this object that are not in the specified locales. locales[0] should be the default language

Overrides:

removeTranslationsOtherThan in class LocalizedObject