Skip navigation links

com.fatwire.assetapi.def
Class AttributeDefProperties

java.lang.Object
com.fatwire.assetapi.def.AttributeDefProperties

public final class AttributeDefProperties

extends java.lang.Object

This class is a container for all properties associated with AttributeDef. These properties and their values (defined here against each property) establish part of the data and part of the run time characteristics for attributes.

Nested Class Summary

static class	AttributeDefProperties.EnumData Indicates the data definition associated with an attribute of type ENUM
static class	AttributeDefProperties.ValueCount Indicates whether the attribute is single valued, multiple valued or a multiple value ordered

Field Summary

static java.lang.String	ANYTYPE
static java.lang.String	FILENAME
static java.lang.String	FOLDER

Constructor Summary

AttributeDefProperties()

Method Summary

AttributeDefProperties	copy()
AttributeDef	getAssetid() Retrieves the assetid information for the attribute
java.util.Map<java.lang.String,java.lang.String>	getAssetRef() Gets the asset reference map of attribute typed Asset
java.lang.String	getAssetType() Retrieves the asset type for attribute typed of asset
java.util.List<java.lang.String>	getAssetTypeDef() Retrieves the asset type for attribute typed of asset
java.lang.String	getAttributeEditor() Retrieves the attribute editor name for this flex attribute type
long	getAttributeId() Gets the flex attribute id for a flex attribute
java.lang.String	getCharset() Gets the charset for the flex attribute
java.lang.String	getContentType() Gets the content type for a blob typed flex attribute
java.lang.String	getConvertEngine() Gets the convert engine name for the attribute
java.util.Map<java.lang.String,AttributeDef>	getDataMap() Gets the datamap for attribute typed List/Array etc.
java.lang.String	getDefaultValue() gets the default value for the Attribute if no other value is specified
DependencyTypeEnum	getDepType() Gets the dependency type of the attribute
java.lang.String	getEditingStyple() Gets the editing style, local or remote , for flex attribute
java.lang.Number	getEndEnum() Gets the ending enum value of attribute typed of STRUCT, ARRAY, ect.
java.lang.String	getEnhancedAttributeEditor() Retrieves the attribute editor name for this flex attribute type
AttributeDefProperties.EnumData	getEnumData() Gets the enum data that the attribute could be valued
java.lang.String	getExternalCol() Gets the external table column name for flex attribute
java.lang.String	getExternalId() Gets the external table column name for the value of external saved flex attribute
java.lang.String	getExternalTable() Gets the external table name of the flex attribute
AttributeDef	getFilter() Gets the filter for this attribute
java.lang.String	getFilterID() Retrieves the flex filter id associated with a flex attribute
int	getMinElementCount() Gets the mininum element count for attribute typed List
int	getMinRowCount() Gets the mininum row count for attribute typed List
DependencyTypeEnum	getMirrorDepType() Retrieves the dependency type for this attribute in term of mirror publishing
AttributeDef	getMultiple() Retrieves the multiple information about the attribute
AttributeDef	getOrdinal() Retrieves the ordinal information for the attribute
AttributeDef	getRequired() Retrieves the required information for the attribute
java.lang.String	getSearchEngineName() Gets the search engine name for the flex attribute
int	getSize() Retrieves the data size of the attribute type
java.lang.Number	getStartEnum() Gets the starting enum value of attribute typed of STRUCT, ARRAY, ect.
java.lang.String	getStorageStyle() Gets the storage style, local or external, for flex attribute
java.util.List<java.lang.String>	getSubtypes()
java.lang.String	getUploadDir() Gets the upload folder for the flex attribute typed url
AttributeDefProperties.ValueCount	getValueCount() Retrieves the ValueCount information(whether attribute is single, multiple, or multiple ordered) of the attribute in the asset definition
boolean	isAllowEmbeddedLinks() Gets whether embedded links are allowed in this flex attribute or not
boolean	isDerivedFlexAttribute() Retrieves whether the attribute is an derived attribute in the asset defintion that contains it
boolean	isEditable() Retrieves whether the attribute is editable or not in the asset
boolean	isInheritedFlexAttribute() Retrieves whether the attribute is an inherited parent attribute or not
void	setAllowEmbeddedLinks(boolean allowEmbeddedLinks) Sets whether the attribute allows embedded links to be created inside its content
void	setAssetid(AttributeDef assetid) Specifies the assetid information of the attribute
void	setAssetRef(java.util.Map<java.lang.String,java.lang.String> assetRef) Sets the asset reference map of attribute typed Asset
void	setAssettTypeDef(java.util.List<java.lang.String> assetTypeDef) Specifies the asset type definition for the attribute typed of asset
void	setAssetType(java.lang.String assetType) Specifies the asset type for attribute typed of asset
void	setAttributeEditor(java.lang.String attributeEditor) Specifies the attribute editor name for this flex attribute type
void	setAttributeId(long attributeId) Sets the id for the attribute
void	setCharset(java.lang.String charset) Sets charset for flex attribute
void	setContentType(java.lang.String contentType) Sets the content type for a blob typed flex attribute
void	setConvertEngine(java.lang.String convertEngine) Sets the convert engine for the attribute
void	setDataMap(java.util.Map<java.lang.String,AttributeDef> dataMap) Sets the datamap for attribute typed List/Array etc.
void	setDefaultValue(java.lang.String defaultValue) Sets the default value for the Attribute
void	setDepType(DependencyTypeEnum depType) Sets the dependency type of this attribute
void	setDerivedFlexAttribute(boolean derivedFlexAttribute) Specifies whether the attribute is an derived attribute in the asset defintion that contains it
void	setEditable(boolean editable) Specifies whether the attribute is editable or not in the asset
void	setEditingStyple(java.lang.String editingStyple) Sets the editing styple of the flex attribute
void	setEndEnum(java.lang.Number endEnum) Sets the ending enum value of attribute typed of STRUCT, ARRAY, ect.
void	setEnhancedAttributeEditor(java.lang.String attributeEditor) Specifies the attribute editor name for this flex attribute type
void	setEnumData(AttributeDefProperties.EnumData enumData) Sets the enum data that the attribute could be valued
void	setExternalCol(java.lang.String externalCol) Sets the Column name of the external table where the attribute is stored
void	setExternalId(java.lang.String externalId) Sets the id in the external table where the flex attribute is stored
void	setExternalTable(java.lang.String externalTable) Sets the external table name for the flex attribute that stored externally
void	setFilter(AttributeDef filter) Sets the filter for this attribute
void	setFilterID(java.lang.String filterID) Specifies the flex filter id associated with a flex attribute
void	setInheritedFlexAttribute(boolean inheritedFlexAttribute) Specifies whether the flex attribute is an attribute that has its values inherited from its parents
void	setMinElementCount(int minElementCount) Sets the mininum element count for attribute typed List
void	setMinRowCount(int minRowCount) Sets the mininum row count for attribute typed List
void	setMirrorDepType(DependencyTypeEnum mirrorDepType) Specifies the dependency type for this attribute in term of mirror publishing
void	setMultiple(AttributeDef multiple) Specifies the multiple information about the
void	setOrdinal(AttributeDef ordinal) Specifies the ordinal inforamtion for the attribute
void	setRequired(AttributeDef required) Specifies the required information for the attribute
void	setSearchEngineName(java.lang.String searchEngineName) Sets the search engine name for the attribute to be indexed with
void	setSize(int size) Sepcifies the size of the attribute
void	setStartEnum(java.lang.Number startEnum) Sets the starting enum value of attribute typed of STRUCT, ARRAY, ect.
void	setStorageStyle(java.lang.String storageStyle) Sets the storage styple, local/external for the flex attribute; local indicates the attribute is stored in Content Server managed table, external indicates the attribute is from other table
void	setSubtypes(java.util.List<java.lang.String> subtypes)
void	setUploadDir(java.lang.String uploadDir) Sets the upload folder for the flex attribute typed url
void	setValueCount(AttributeDefProperties.ValueCount valueCount) Specifies the ValueCount information(whether attribute is single, multiple, or multiple ordered) of the attribute in the asset definition

Methods inherited from class java.lang.Object

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

Field Detail

FOLDER

public static java.lang.String FOLDER

FILENAME

public static java.lang.String FILENAME

ANYTYPE

public static java.lang.String ANYTYPE

Constructor Detail

AttributeDefProperties

public AttributeDefProperties()

Method Detail

getFilterID

public java.lang.String getFilterID()

Retrieves the flex filter id associated with a flex attribute

Returns:

the String filter id

setFilterID

public void setFilterID(java.lang.String filterID)

Specifies the flex filter id associated with a flex attribute

Parameters:

filterID - the String filter id

getDepType

public DependencyTypeEnum getDepType()

Gets the dependency type of the attribute

Returns:

the type of the dependency

setDepType

public void setDepType(DependencyTypeEnum depType)

Sets the dependency type of this attribute

Parameters:

depType - the dependency type

isInheritedFlexAttribute

public boolean isInheritedFlexAttribute()

Retrieves whether the attribute is an inherited parent attribute or not

Returns:

true, if it is an inherited attribute from parent; false, if it is not

setInheritedFlexAttribute

public void setInheritedFlexAttribute(boolean inheritedFlexAttribute)

Specifies whether the flex attribute is an attribute that has its values inherited from its parents

Parameters:

inheritedFlexAttribute - true indicates this attribute is an inherited attribute, false indicates not

getFilter

public AttributeDef getFilter()

Gets the filter for this attribute

Returns:

the filter

setFilter

public void setFilter(AttributeDef filter)

Sets the filter for this attribute

Parameters:

filter - the filter

getMultiple

public AttributeDef getMultiple()

Retrieves the multiple information about the attribute

Returns:

the object typed of AttributeDef to indicates whether the attribute is multiple or not

setMultiple

public void setMultiple(AttributeDef multiple)

Specifies the multiple information about the

Parameters:

multiple - the object typed of AttributeDef to indicates whether the attribute is multiple or not

getAssetid

public AttributeDef getAssetid()

Retrieves the assetid information for the attribute

Returns:

the object that contains the object id information

setAssetid

public void setAssetid(AttributeDef assetid)

Specifies the assetid information of the attribute

Parameters:

assetid - the object that contains the object id information

getOrdinal

public AttributeDef getOrdinal()

Retrieves the ordinal information for the attribute

Returns:

the oridnal information

setOrdinal

public void setOrdinal(AttributeDef ordinal)

Specifies the ordinal inforamtion for the attribute

Parameters:

ordinal - the oridnal information

getRequired

public AttributeDef getRequired()

Retrieves the required information for the attribute

Returns:

the reqired or not information for the attribute

setRequired

public void setRequired(AttributeDef required)

Specifies the required information for the attribute

Parameters:

required - the required information for the attribute

isDerivedFlexAttribute

public boolean isDerivedFlexAttribute()

Retrieves whether the attribute is an derived attribute in the asset defintion that contains it

Returns:

true indicates this attribute is a derived attribute in the definition, false otherwise

setDerivedFlexAttribute

public void setDerivedFlexAttribute(boolean derivedFlexAttribute)

Specifies whether the attribute is an derived attribute in the asset defintion that contains it

Parameters:

derivedFlexAttribute - true indicates this attribute is a derived attribute in the definition, false otherwise

getValueCount

public AttributeDefProperties.ValueCount getValueCount()

Retrieves the ValueCount information(whether attribute is single, multiple, or multiple ordered) of the attribute in the asset definition

Returns:

the valuecount for this attribute definition

setValueCount

public void setValueCount(AttributeDefProperties.ValueCount valueCount)

Specifies the ValueCount information(whether attribute is single, multiple, or multiple ordered) of the attribute in the asset definition

Parameters:

valueCount - the valuecount for this attribute definition

getAssetType

public java.lang.String getAssetType()

Retrieves the asset type for attribute typed of asset

Returns:

the asset type name

setAssetType

public void setAssetType(java.lang.String assetType)

Specifies the asset type for attribute typed of asset

Parameters:

assetType - the asset type name

getAssetTypeDef

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

Retrieves the asset type for attribute typed of asset

Returns:

the asset type name

setAssettTypeDef

public void setAssettTypeDef(java.util.List<java.lang.String> assetTypeDef)

Specifies the asset type definition for the attribute typed of asset

Parameters:

assetTypeDef - the asset type definition

getMirrorDepType

public DependencyTypeEnum getMirrorDepType()

Retrieves the dependency type for this attribute in term of mirror publishing

Returns:

the dependency type

setMirrorDepType

public void setMirrorDepType(DependencyTypeEnum mirrorDepType)

Specifies the dependency type for this attribute in term of mirror publishing

Parameters:

mirrorDepType - the dependency type

getAttributeEditor

public java.lang.String getAttributeEditor()

Retrieves the attribute editor name for this flex attribute type

Returns:

the name of the attribute editor

setAttributeEditor

public void setAttributeEditor(java.lang.String attributeEditor)

Specifies the attribute editor name for this flex attribute type

Parameters:

attributeEditor - the name of the attribute editor

getEnhancedAttributeEditor

public java.lang.String getEnhancedAttributeEditor()

Retrieves the attribute editor name for this flex attribute type

Returns:

the name of the attribute editor

setEnhancedAttributeEditor

public void setEnhancedAttributeEditor(java.lang.String attributeEditor)

Specifies the attribute editor name for this flex attribute type

Parameters:

attributeEditor - the name of the attribute editor

getSize

public int getSize()

Retrieves the data size of the attribute type

Returns:

the size of the attribute data

setSize

public void setSize(int size)

Sepcifies the size of the attribute

Parameters:

size - the size of the attribute data

isEditable

public boolean isEditable()

Retrieves whether the attribute is editable or not in the asset

Returns:

true indicates the attribute is editable, false indicates otherwise

setEditable

public void setEditable(boolean editable)

Specifies whether the attribute is editable or not in the asset

Parameters:

editable - true indicates the attribute is editable, false indicates otherwise

getDataMap

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

Gets the datamap for attribute typed List/Array etc.

Returns:

the data map

setDataMap

public void setDataMap(java.util.Map<java.lang.String,AttributeDef> dataMap)

Sets the datamap for attribute typed List/Array etc.

Parameters:

dataMap - the datamap

getEnumData

public AttributeDefProperties.EnumData getEnumData()

Gets the enum data that the attribute could be valued

Returns:

the enum data object

setEnumData

public void setEnumData(AttributeDefProperties.EnumData enumData)

Sets the enum data that the attribute could be valued

Parameters:

enumData - the enum data

getMinRowCount

public int getMinRowCount()

Gets the mininum row count for attribute typed List

Returns:

the mininum row count

setMinRowCount

public void setMinRowCount(int minRowCount)

Sets the mininum row count for attribute typed List

Parameters:

minRowCount - the mininum row count

getMinElementCount

public int getMinElementCount()

Gets the mininum element count for attribute typed List

Returns:

the mininum row count

setMinElementCount

public void setMinElementCount(int minElementCount)

Sets the mininum element count for attribute typed List

Parameters:

minElementCount - the mininum row count

getStartEnum

public java.lang.Number getStartEnum()

Gets the starting enum value of attribute typed of STRUCT, ARRAY, ect. and with enum data specified

Returns:

the start enum object

setStartEnum

public void setStartEnum(java.lang.Number startEnum)

Sets the starting enum value of attribute typed of STRUCT, ARRAY, ect. and with enum data specified

Parameters:

startEnum - the start enum object

getEndEnum

public java.lang.Number getEndEnum()

Gets the ending enum value of attribute typed of STRUCT, ARRAY, ect. and with enum data specified

Returns:

the end enum object

setEndEnum

public void setEndEnum(java.lang.Number endEnum)

Sets the ending enum value of attribute typed of STRUCT, ARRAY, ect. and with enum data specified

Parameters:

endEnum - the end enum object

getAssetRef

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

Gets the asset reference map of attribute typed Asset

Returns:

the reference map

setAssetRef

public void setAssetRef(java.util.Map<java.lang.String,java.lang.String> assetRef)

Sets the asset reference map of attribute typed Asset

Parameters:

assetRef - the reference map

getUploadDir

public java.lang.String getUploadDir()

Gets the upload folder for the flex attribute typed url

Returns:

the string folder name

setUploadDir

public void setUploadDir(java.lang.String uploadDir)

Sets the upload folder for the flex attribute typed url

Parameters:

uploadDir - the string folder name

isAllowEmbeddedLinks

public boolean isAllowEmbeddedLinks()

Gets whether embedded links are allowed in this flex attribute or not

Returns:

TRUE/FALSE

setAllowEmbeddedLinks

public void setAllowEmbeddedLinks(boolean allowEmbeddedLinks)

Sets whether the attribute allows embedded links to be created inside its content

Parameters:

allowEmbeddedLinks - TRUE indicates embeddedLinks are allowed, FALSE indicates otherwise

getEditingStyple

public java.lang.String getEditingStyple()

Gets the editing style, local or remote , for flex attribute

Returns:

the editing style

setEditingStyple

public void setEditingStyple(java.lang.String editingStyple)

Sets the editing styple of the flex attribute

Parameters:

editingStyple -

getStorageStyle

public java.lang.String getStorageStyle()

Gets the storage style, local or external, for flex attribute

Returns:

the storage style

setStorageStyle

public void setStorageStyle(java.lang.String storageStyle)

Sets the storage styple, local/external for the flex attribute; local indicates the attribute is stored in Content Server managed table, external indicates the attribute is from other table

Parameters:

storageStyle - local or external

getExternalId

public java.lang.String getExternalId()

Gets the external table column name for the value of external saved flex attribute

Returns:

the external table column name

setExternalId

public void setExternalId(java.lang.String externalId)

Sets the id in the external table where the flex attribute is stored

Parameters:

externalId - the identifier

getExternalCol

public java.lang.String getExternalCol()

Gets the external table column name for flex attribute

Returns:

the external table column name

setExternalCol

public void setExternalCol(java.lang.String externalCol)

Sets the Column name of the external table where the attribute is stored

Parameters:

externalCol - the column name in the external table

getExternalTable

public java.lang.String getExternalTable()

Gets the external table name of the flex attribute

Returns:

the external table name

setExternalTable

public void setExternalTable(java.lang.String externalTable)

Sets the external table name for the flex attribute that stored externally

Parameters:

externalTable - table name

getCharset

public java.lang.String getCharset()

Gets the charset for the flex attribute

Returns:

the charset

setCharset

public void setCharset(java.lang.String charset)

Sets charset for flex attribute

Parameters:

charset - the String form of the charset

getContentType

public java.lang.String getContentType()

Gets the content type for a blob typed flex attribute

Returns:

the content type

setContentType

public void setContentType(java.lang.String contentType)

Sets the content type for a blob typed flex attribute

Parameters:

contentType - the String form of the content type

getSearchEngineName

public java.lang.String getSearchEngineName()

Gets the search engine name for the flex attribute

Returns:

the search engine name

setSearchEngineName

public void setSearchEngineName(java.lang.String searchEngineName)

Sets the search engine name for the attribute to be indexed with

Parameters:

searchEngineName - the search engine name (Verity, for example)

getConvertEngine

public java.lang.String getConvertEngine()

Gets the convert engine name for the attribute

Returns:

the convert engine name

setConvertEngine

public void setConvertEngine(java.lang.String convertEngine)

Sets the convert engine for the attribute

Parameters:

convertEngine -

getAttributeId

public long getAttributeId()

Gets the flex attribute id for a flex attribute

Returns:

the id of the flex attribute

setAttributeId

public void setAttributeId(long attributeId)

Sets the id for the attribute

Parameters:

attributeId -

getSubtypes

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

setSubtypes

public void setSubtypes(java.util.List<java.lang.String> subtypes)

getDefaultValue

public java.lang.String getDefaultValue()

gets the default value for the Attribute if no other value is specified

Returns:

the String format of the default value

setDefaultValue

public void setDefaultValue(java.lang.String defaultValue)

Sets the default value for the Attribute

Parameters:

defaultValue - the String format of the default value

copy

public final AttributeDefProperties copy()

Skip navigation links