Package com.microstrategy.web.transform

Class LayoutSourceDefnImpl

java.lang.Object

com.microstrategy.utils.config.AbstractConfigurationElement

com.microstrategy.web.transform.AbstractStyleCatalogElement

com.microstrategy.web.transform.LayoutSourceDefnImpl

All Implemented Interfaces:

ConfigurationElement, ConfigurationFile, LayoutSourceDefn, java.lang.Cloneable

public class LayoutSourceDefnImpl
extends AbstractStyleCatalogElement
implements LayoutSourceDefn

The LayoutSourceDefnImpl class implements the LayoutSourceDefn interface for the Style Catalog.

Since:

MicroStrategy Web 8.0.0

Nested Class Summary

Nested classes/interfaces inherited from class com.microstrategy.utils.config.AbstractConfigurationElement

AbstractConfigurationElement.FilteredList

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String	ATT_CLASS
protected static java.lang.String	ATT_NAME
protected static java.lang.String	NODE_LAYOUT_SOURCE_DEFN

Fields inherited from class com.microstrategy.utils.config.AbstractConfigurationElement

ATT_CONFIG_SRC, ATT_DELETED, ATT_POSITION, ATT_PROTOTYPE, ATT_USE_DEFAULT

Constructor Summary

Constructors

Constructor	Description
LayoutSourceDefnImpl()

Method Summary

Modifier and Type	Method	Description
protected void	clearCaches()	This method is invoked whenever the structure of the style catalog has changed and caches to other objects in the structure needs to be updated.
java.lang.String	getImplClassName()	Gets the fully qualified class name for the layout source.
protected java.lang.String	getKeyAttribute()	This method must return the attribute that uniquely identifies this element among its siblings; if no single attribute can be used, return null and override the getKey and setKey methods.
LayoutSource	getLayoutSourceInstance()	Creates or returns an existing instance of the referred layout source.
java.lang.String	getName()	Gets the name associated with this layout source.
void	setImplClassName(java.lang.String fqcn)	Sets the fully qualified class name for the layout source.
void	setName(java.lang.String name)	Sets the name of the layout source.

Methods inherited from class com.microstrategy.web.transform.AbstractStyleCatalogElement

copyContents, getStyleCatalog, hasChanged, reload, resetChanged, setStrAttribute

Methods inherited from class com.microstrategy.utils.config.AbstractConfigurationElement

addFileSource, applyCustomization, applyCustomizations, cleanUpDeletedElements, clone, delete, deltas, deltas, equalAtts, equalElements, equalNodeValues, equals, equalsIncludingDeletedElements, exportAttributesToXML, exportElementsToXML, exportNodeValueToXML, getAttribute, getAttributes, getBoolAttribute, getChildKey, getConfigSrc, getDTDFileName, getElement, getElement, getElements, getFileLoader, getIntAttribute, getIntAttribute, getKey, getLineNumber, getList, getNextKey, getNodeName, getNodeValue, getNodeValue, getOrCreateElement, getParent, getPosition, getPrototype, getRegisteredClass, getSelfInitPath, getSource, getStrAttribute, getUseDefault, getXMLParserParameters, getXMLSerializerParameters, hashCode, hashCodeAtts, hashCodeElements, hashCodeNodeValues, hasRegisteredClass, initAttributesFromXML, initDefaultAttributes, initElementFromXML, initElementsFromXML, initFromFile, initFromResource, initFromXML, initFromXML, initNodeValueFromXML, initPrototype, isActive, isCustomized, isDeleted, isDirty, isInSource, isKeyAttribute, load, mergeChanges, newChildInstance, newSource, original, populate, printAttributes, printElements, printNodeValue, refreshLists, registerClass, registerElement, registerElement, registerElementList, reloadPrototype, removeAttribute, removeDefaults, replaceList, restore, save, save, saveChangesAs, saveConfig, saveFlatXML, saveNode, saveSource, setAttribute, setBoolAttribute, setChildOriginals, setConfigSrc, setCustomized, setElement, setFileLoader, setIntAttribute, setKey, setLineNumber, setNodeName, setNodeValue, setPosition, setPrototype, setSelfInitPath, setUseDefault, setUseValidation, throwConfigParseException, toString, toXML, toXML, toXML, toXML, useNodeValue, useValidation

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.microstrategy.utils.config.ConfigurationElement

getAttribute, getAttributes, getElement, getElements, getKey, getNodeName, getStrAttribute, initFromXML, reload, toXML

Field Detail

ATT_NAME

protected static final java.lang.String ATT_NAME

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

ATT_CLASS

protected static final java.lang.String ATT_CLASS

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

NODE_LAYOUT_SOURCE_DEFN

protected static final java.lang.String NODE_LAYOUT_SOURCE_DEFN

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

Constructor Detail

LayoutSourceDefnImpl

public LayoutSourceDefnImpl()

Since:

MicroStrategy Web 9.0.0

Method Detail

clearCaches

protected void clearCaches()

Description copied from class: AbstractStyleCatalogElement

This method is invoked whenever the structure of the style catalog has changed and caches to other objects in the structure needs to be updated.

Overrides:

clearCaches in class AbstractStyleCatalogElement

Since:

MicroStrategy Web 9.0.0

getName

public java.lang.String getName()

Description copied from interface: LayoutSourceDefn

Gets the name associated with this layout source.

Specified by:

getName in interface LayoutSourceDefn

Returns:

The name of the layout source.

setName

public void setName(java.lang.String name)
             throws java.lang.IllegalArgumentException

Description copied from interface: LayoutSourceDefn

Sets the name of the layout source. The name is used in other places where a layout source is required.

Specified by:

setName in interface LayoutSourceDefn

Parameters:

name - The name of the layout source.

Throws:

java.lang.IllegalArgumentException - If the name is already used, then this exception is thrown.

getImplClassName

public java.lang.String getImplClassName()

Description copied from interface: LayoutSourceDefn

Gets the fully qualified class name for the layout source.

Specified by:

getImplClassName in interface LayoutSourceDefn

Returns:

The fully qualified class name for the layout source.

setImplClassName

public void setImplClassName(java.lang.String fqcn)

Description copied from interface: LayoutSourceDefn

Sets the fully qualified class name for the layout source.

Specified by:

setImplClassName in interface LayoutSourceDefn

Parameters:

fqcn - The fully qualified class name.

getLayoutSourceInstance

public LayoutSource getLayoutSourceInstance()

Description copied from interface: LayoutSourceDefn

Creates or returns an existing instance of the referred layout source.

Specified by:

getLayoutSourceInstance in interface LayoutSourceDefn

Returns:

An instance of the layout source object.

getKeyAttribute

protected java.lang.String getKeyAttribute()

Description copied from class: AbstractConfigurationElement

This method must return the attribute that uniquely identifies this element among its siblings; if no single attribute can be used, return null and override the getKey and setKey methods.

Specified by:

getKeyAttribute in class AbstractConfigurationElement

Since:

MicroStrategy Web 9.0.0