com.kheops.jmap.server

Class ExternalAttribute

java.lang.Object

com.kheops.jmap.metadata.LocalizedObject

com.kheops.jmap.metadata.Attribute

com.kheops.jmap.server.ExternalAttribute

All Implemented Interfaces:

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

Direct Known Subclasses:

MultipleExternalAttribute

public class ExternalAttribute
extends Attribute
implements IExternalAttribute

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	AGGREGATION_TYPE_AVERAGE
static int	AGGREGATION_TYPE_FIRST_ELEMENT
static int	AGGREGATION_TYPE_SUM
static int	VALUE_FROM_FIELD
static int	VALUE_FROM_SQL

Fields inherited from class com.kheops.jmap.metadata.Attribute

readOnly

Constructor Summary

Constructors

Constructor and Description
ExternalAttribute()
ExternalAttribute(java.lang.String name, java.lang.String title, int type)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Returns a deep copy of the current instance.
int	getAggregationType()
int	getDatabaseId()
java.lang.String	getExtLinkField()
int	getExtLinkFieldType() Not currently used.
java.lang.String	getExtSchema()
java.lang.String	getExtTable()
java.lang.String	getExtValueField()
java.lang.String	getExtValueSQLQuery()
int	getFieldValueSource()
java.lang.String	getLayerLinkField()
IExternalAttributeLoader	getLoader() Returns the DynamicAttributeLoader related to this attribute.
java.lang.String	getLocalKeyField()
char	getSeparator()
boolean	isDynamic() Returns true if values loaded from this attribute are dynamically loaded.
boolean	isSystem()
void	setAggregationType(int aggregationType)
void	setDatabaseId(int databaseId)
void	setDynamic(boolean realTime) Sets whether this external attribute is dynamic or not.
void	setExtLinkField(java.lang.String extLinkField)
void	setExtLinkFieldType(int extLinkFieldType) Not currently used.
void	setExtSchema(java.lang.String extSchema)
void	setExtTable(java.lang.String extTable)
void	setExtValueField(java.lang.String extValueField)
void	setExtValueSQLQuery(java.lang.String extValueSQLQuery)
void	setFieldValueSource(int fieldValueSource)
void	setLayerLinkField(java.lang.String layerLinkField)
void	setSeparator(char separator)

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

compareTo, equals, getAttributeStat, getFormatPattern, getName, getTitle, getTitle, getType, hashCode, isIndexed, isNullable, isReadOnly, removeTranslationsOtherThan, setAttributeStat, setFormatPattern, setIndexed, setName, setNullable, setReadOnly, setTitle, setTitle, setType, 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

AGGREGATION_TYPE_FIRST_ELEMENT

public static final int AGGREGATION_TYPE_FIRST_ELEMENT

See Also:

Constant Field Values

AGGREGATION_TYPE_AVERAGE

public static final int AGGREGATION_TYPE_AVERAGE

See Also:

Constant Field Values

AGGREGATION_TYPE_SUM

public static final int AGGREGATION_TYPE_SUM

See Also:

Constant Field Values

VALUE_FROM_FIELD

public static final int VALUE_FROM_FIELD

See Also:

Constant Field Values

VALUE_FROM_SQL

public static final int VALUE_FROM_SQL

See Also:

Constant Field Values

Constructor Detail

ExternalAttribute

public ExternalAttribute()

ExternalAttribute

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

Method Detail

getDatabaseId

public int getDatabaseId()

Returns:

setDatabaseId

public void setDatabaseId(int databaseId)

Parameters:

databaseId -

getExtLinkField

public java.lang.String getExtLinkField()

Returns:

getLocalKeyField

public java.lang.String getLocalKeyField()

Specified by:

getLocalKeyField in interface IExternalAttribute

getLayerLinkField

public java.lang.String getLayerLinkField()

Returns:

setExtLinkField

public void setExtLinkField(java.lang.String extLinkField)

Parameters:

extLinkField -

setLayerLinkField

public void setLayerLinkField(java.lang.String layerLinkField)

Parameters:

layerLinkField -

getExtValueField

public java.lang.String getExtValueField()

Returns:

setExtValueField

public void setExtValueField(java.lang.String extValueField)

Parameters:

extValueField -

getExtLinkFieldType

public int getExtLinkFieldType()

Not currently used.

Returns:

setExtLinkFieldType

public void setExtLinkFieldType(int extLinkFieldType)

Not currently used.

Parameters:

extLinkFieldType -

getAggregationType

public int getAggregationType()

Returns:

setAggregationType

public void setAggregationType(int aggregationType)

Parameters:

aggregationType -

getFieldValueSource

public int getFieldValueSource()

Returns:

setFieldValueSource

public void setFieldValueSource(int fieldValueSource)

Parameters:

fieldValueSource -

getExtValueSQLQuery

public java.lang.String getExtValueSQLQuery()

Returns:

setExtValueSQLQuery

public void setExtValueSQLQuery(java.lang.String extValueSQLQuery)

Parameters:

extValueSQLQuery -

getExtSchema

public java.lang.String getExtSchema()

Returns:

getExtTable

public java.lang.String getExtTable()

Returns:

setExtSchema

public void setExtSchema(java.lang.String extSchema)

Parameters:

extSchema -

setExtTable

public void setExtTable(java.lang.String extTable)

Parameters:

extTable -

getSeparator

public char getSeparator()

Returns:

setSeparator

public void setSeparator(char separator)

Parameters:

separator -

isSystem

public boolean isSystem()

isDynamic

public boolean isDynamic()

Returns true if values loaded from this attribute are dynamically loaded.

Specified by:

isDynamic in interface IExternalAttribute

Returns:

whether this external attribute is dynamic or not.

Since:

6.0

setDynamic

public void setDynamic(boolean realTime)

Sets whether this external attribute is dynamic or not.

Parameters:

realTime - a flag that defines if values loaded from this attribute are dynamically loaded.

Since:

6.0

getLoader

public IExternalAttributeLoader getLoader()

Returns the DynamicAttributeLoader related to this attribute. If this attribute is not dynamic, then null is returned.

Specified by:

getLoader in interface IExternalAttribute

Returns:

the DynamicAttributeLoader related to this attribute, or null if the attribute is not dynamic.

clone

public java.lang.Object clone()

Description copied from class: Attribute

Returns a deep copy of the current instance.

Overrides:

clone in class Attribute

Returns:

a deep copy of the current instance.