com.ibm.ecm.configuration

Class ViewerConfig

  1. java.lang.Object
  2. extended bycom.ibm.ecm.configuration.ConfigurationObject
  3. extended bycom.ibm.ecm.configuration.ViewerConfig
  1. public class ViewerConfig
  2. extends ConfigurationObject

Field Summary

Fields inherited from class com.ibm.ecm.configuration.ConfigurationObject
ARRAY_DELIMITER, cloned, KEY_DELIMITER, LIST_ESC_CHAR, LIST_ESCAPE, LIST_SEPARATOR, MODIFIER, properties

Constructor Summary

Constructor and Description
ViewerConfig(org.apache.commons.configuration.Configuration configuration,java.lang.String idPrefix,java.lang.String id)

Method Summary

Modifier and Type Method and Description
  1. void
 delete()
  1. protected
  2. java.lang.Class
 getDataType(java.lang.String key)
  1. java.lang.String
 getDescription()
  1. java.util.Collection
 getList(java.lang.String type,java.lang.String appName,javax.servlet.http.HttpServletRequest request)
  1. java.lang.String[]
 getMappingsId()
  1. java.lang.String
 getName()
  1. java.lang.String
 getObjectType()
  1. java.util.Collection<ViewerMappingConfig>
 getViewerMappingList()
  1. JSONArray
 getViewerMappingsJSON()
  1. java.util.Map<java.lang.String,ViewerMappingConfig>
 getViewerMappingsMap()
  1. void
 setDescription(java.lang.String name)
  1. void
 setMappingsId(java.lang.String[] mappings)
  1. void
 setName(java.lang.String name)
Methods inherited from class com.ibm.ecm.configuration.ConfigurationObject
addValueToList, arrayToString, covertEmptyStringtoNull, dump, getConfigurationObject, getDataTypeValue, getIdPrefix, getKey, getMap, getObjectId, getPropertyNames, getPropertyValue, getPropertyValue, getPropertyValue, getPropertyValue, isEmpty, load, propertiesToString, removeValuesFromList, removeValuesFromList, save, setDefaultValue, setProperty, setValues, setValues, setValues, skipThisPropertyWhenSaving, stringToArray, stringToList, toJSON, toString, writeConfigurationToFile
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ViewerConfig

  1. public ViewerConfig(org.apache.commons.configuration.Configuration configuration,
  2. java.lang.String idPrefix,
  3. java.lang.String id)

Method Detail

getObjectType

  1. public java.lang.String getObjectType( )
Description copied from class: ConfigurationObject
Abstract method to return object type.
Specified by:
getObjectType in class ConfigurationObject
Returns:
a string object type back, for example "desktop", "repository"...

getDataType

  1. protected java.lang.Class getDataType( java.lang.String key)
Description copied from class: ConfigurationObject
Returns the datatype of a configuration property. This is implemented in subclasses and is used to properly serialize the properties. The default implementation returns null which indicates that compatible behavior should be used, which inspects the property value itself and guesses at the type of the property.
Overrides:
getDataType in class ConfigurationObject
Returns:
a Class instance describing the datatype of the property.

getList

  1. public java.util.Collection getList( java.lang.String type,
  2. java.lang.String appName,
  3. javax.servlet.http.HttpServletRequest request)
Description copied from class: ConfigurationObject
Abstract method that needs to be override in concrete class to a return a collection back by type.
Overrides:
getList in class ConfigurationObject
Parameters:
type - - A string value of object type.
appName - - A string value of application name.
request - - A HttpServletRequest object.
Returns:
a collection of type.

setName

  1. public void setName(java.lang.String name)

getName

  1. public java.lang.String getName( )
Overrides:
getName in class ConfigurationObject

setDescription

  1. public void setDescription(java.lang.String name)

getDescription

  1. public java.lang.String getDescription( )

getMappingsId

  1. public java.lang.String[] getMappingsId( )

setMappingsId

  1. public void setMappingsId(java.lang.String[] mappings)

getViewerMappingList

  1. public java.util.Collection<ViewerMappingConfig> getViewerMappingList( )

getViewerMappingsMap

  1. public java.util.Map<java.lang.String,ViewerMappingConfig> getViewerMappingsMap( )

getViewerMappingsJSON

  1. public JSONArray getViewerMappingsJSON( )

delete

  1. public void delete()
Description copied from class: ConfigurationObject
Remove this configuration object from the DB.
Overrides:
delete in class ConfigurationObject