com.tsgrp.opencontent.core.config

Class AbstractDictionaryServiceImpl

java.lang.Object

com.tsgrp.opencontent.core.config.AbstractDictionaryServiceImpl

All Implemented Interfaces:

DictionaryService

Direct Known Subclasses:

AlfrescoEmbDictionaryServiceImpl, DctmDictionaryServiceImpl, LocalDictionaryServiceImpl, S3DictionaryServiceImpl

public abstract class AbstractDictionaryServiceImpl
extends java.lang.Object
implements DictionaryService

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,OCAspectDefinition>	aspectDefinitionsByOCName
protected java.util.Map<OCPropertyDefinition,OCAspectDefinition>	aspectDefinitionsByPropertyDefinition
protected java.util.Map<java.lang.String,OCAspectDefinition>	aspectDefinitionsByRepoName
protected java.util.Map<java.lang.String,java.lang.String>	oCConstantNames
protected java.util.Map<java.lang.String,OCPropertyDefinition>	propertyDefinitionsByOCName
protected java.util.Map<java.lang.String,OCPropertyDefinition>	propertyDefinitionsByRepoName
protected java.util.Map<java.lang.String,OCTypeDefinition>	typeDefinitionsByOCName
protected java.util.Map<java.lang.String,OCTypeDefinition>	typeDefinitionsByRepoName

Constructor Summary

Constructors

Constructor and Description
AbstractDictionaryServiceImpl()

Method Summary

Modifier and Type	Method and Description
java.io.File	exportDictionary() Exports all data in the dictionary service to an XML file by calling a pojoToXml marshalling method.
OCAspectDefinition	getAspect(java.lang.String aspectName) Gets an OCAspectDefinition by OC name.
java.util.Map<java.lang.String,OCAspectDefinition>	getAspectDefinitions() Gets a map keyed by aspect name
protected java.util.Map<java.lang.String,OCAspectDefinition>	getAspectDefinitionsByOCName()
java.util.Map<OCPropertyDefinition,OCAspectDefinition>	getAspectDefinitionsByPropertyDefinition() Gets a Map of OCProperty definitions and the OCAspectDefinitions This maps a property to the aspect it comes from
protected java.util.Map<java.lang.String,OCAspectDefinition>	getAspectDefinitionsByRepoName()
java.util.Set<java.lang.String>	getAspects() Gets a list of Aspect Names
OCPropertyDefinition	getPropertyDefinition(java.lang.String propertyName) Gets an OCPropertyDefinition by OC name.
OCPropertyDefinition	getPropertyDefinitionByRepoName(java.lang.String propertyName) Gets an OCPropertyDefinition by repo name.
OCTypeDefinition	getType(java.lang.String typeName) Gets an OCTypeDefinition by OC name.
OCTypeDefinition	getTypeByRepoName(java.lang.String repoType) Gets an OCTypeDefinition by repo name.
java.util.Map<java.lang.String,OCTypeDefinition>	getTypeDefinitions() Gets a map keyed by ocType name
protected java.util.Map<java.lang.String,OCTypeDefinition>	getTypeDefinitionsByOCName()
protected java.util.Map<java.lang.String,OCTypeDefinition>	getTypeDefinitionsByRepoName()
java.util.Set<java.lang.String>	getTypes() Gets a list of OC Type Names
protected void	init()
static java.io.File	pojoAspectToXml(java.util.Collection<OCAspectDefinition> pojo) Converts a POJO aspectDefinition object to an XML object
static java.io.File	pojoTypeToXml(java.util.Collection<OCTypeDefinition> pojo) Converts a POJO typeDefinition object to an XML object
abstract void	populateMaps()
java.lang.String	repoNameToOCName(java.lang.String repoName)
java.lang.String	repoNameToOCName(java.lang.String prefix, java.lang.String localName)
void	setOCConstantNames(java.util.Map<java.lang.String,java.lang.String> oCConstantNames)
java.lang.String	updateDictionary() Refreshes the Dictionary.
java.lang.String	updateJsonDictionary(java.lang.String ticket, javax.servlet.http.HttpServletRequest request) Updates the dictionary json.

Methods inherited from class java.lang.Object

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

Field Detail

typeDefinitionsByOCName

protected java.util.Map<java.lang.String,OCTypeDefinition> typeDefinitionsByOCName

aspectDefinitionsByOCName

protected java.util.Map<java.lang.String,OCAspectDefinition> aspectDefinitionsByOCName

typeDefinitionsByRepoName

protected java.util.Map<java.lang.String,OCTypeDefinition> typeDefinitionsByRepoName

aspectDefinitionsByRepoName

protected java.util.Map<java.lang.String,OCAspectDefinition> aspectDefinitionsByRepoName

propertyDefinitionsByOCName

protected java.util.Map<java.lang.String,OCPropertyDefinition> propertyDefinitionsByOCName

propertyDefinitionsByRepoName

protected java.util.Map<java.lang.String,OCPropertyDefinition> propertyDefinitionsByRepoName

oCConstantNames

protected java.util.Map<java.lang.String,java.lang.String> oCConstantNames

aspectDefinitionsByPropertyDefinition

protected java.util.Map<OCPropertyDefinition,OCAspectDefinition> aspectDefinitionsByPropertyDefinition

Constructor Detail

AbstractDictionaryServiceImpl

public AbstractDictionaryServiceImpl()

Method Detail

populateMaps

public abstract void populateMaps()

init

protected void init()

repoNameToOCName

public java.lang.String repoNameToOCName(java.lang.String repoName)

repoNameToOCName

public java.lang.String repoNameToOCName(java.lang.String prefix,
                                         java.lang.String localName)

getTypeDefinitionsByOCName

protected java.util.Map<java.lang.String,OCTypeDefinition> getTypeDefinitionsByOCName()

getAspectDefinitionsByOCName

protected java.util.Map<java.lang.String,OCAspectDefinition> getAspectDefinitionsByOCName()

getTypeDefinitionsByRepoName

protected java.util.Map<java.lang.String,OCTypeDefinition> getTypeDefinitionsByRepoName()

getAspectDefinitionsByRepoName

protected java.util.Map<java.lang.String,OCAspectDefinition> getAspectDefinitionsByRepoName()

setOCConstantNames

public void setOCConstantNames(java.util.Map<java.lang.String,java.lang.String> oCConstantNames)

getTypes

public java.util.Set<java.lang.String> getTypes()

Description copied from interface: DictionaryService

Gets a list of OC Type Names

Specified by:

getTypes in interface DictionaryService

Returns:

a Set of OC Type Names

getTypeDefinitions

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

Description copied from interface: DictionaryService

Gets a map keyed by ocType name

Specified by:

getTypeDefinitions in interface DictionaryService

Returns:

a Map keyed by ocType Name.

getType

public OCTypeDefinition getType(java.lang.String typeName)

Description copied from interface: DictionaryService

Gets an OCTypeDefinition by OC name. If the OC name isn't in the dictionary this method returns null.

Specified by:

getType in interface DictionaryService

Returns:

the OCTypeDefinition. if the OC name isn't in the dictionary, returns null.

getTypeByRepoName

public OCTypeDefinition getTypeByRepoName(java.lang.String repoType)

Description copied from interface: DictionaryService

Gets an OCTypeDefinition by repo name. If the repo name isn't in the dictionary this method returns null.

Specified by:

getTypeByRepoName in interface DictionaryService

Returns:

the OCTypeDefinition. if the repo name isn't in the dictionary, returns null.

getPropertyDefinition

public OCPropertyDefinition getPropertyDefinition(java.lang.String propertyName)

Description copied from interface: DictionaryService

Gets an OCPropertyDefinition by OC name. If the OC name isn't in the dictionary this method returns null.

Specified by:

getPropertyDefinition in interface DictionaryService

Returns:

the OCPropertyDefinition. if the OC name isn't in the dictionary, returns null.

getPropertyDefinitionByRepoName

public OCPropertyDefinition getPropertyDefinitionByRepoName(java.lang.String propertyName)

Description copied from interface: DictionaryService

Gets an OCPropertyDefinition by repo name. If the repo name isn't in the dictionary this method returns null.

Specified by:

getPropertyDefinitionByRepoName in interface DictionaryService

Returns:

the OCPropertyDefinition. if the repo name isn't in the dictionary, returns null.

getAspects

public java.util.Set<java.lang.String> getAspects()

Description copied from interface: DictionaryService

Gets a list of Aspect Names

Specified by:

getAspects in interface DictionaryService

Returns:

a Set of Aspect Names

getAspectDefinitions

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

Description copied from interface: DictionaryService

Gets a map keyed by aspect name

Specified by:

getAspectDefinitions in interface DictionaryService

Returns:

a Map keyed by aspect Name.

getAspect

public OCAspectDefinition getAspect(java.lang.String aspectName)

Description copied from interface: DictionaryService

Gets an OCAspectDefinition by OC name. If the OC name isn't in the dictionary this method returns null.

Specified by:

getAspect in interface DictionaryService

Returns:

the OCAspectDefinition. if the OC name isn't in the dictionary, returns null.

getAspectDefinitionsByPropertyDefinition

public java.util.Map<OCPropertyDefinition,OCAspectDefinition> getAspectDefinitionsByPropertyDefinition()

Description copied from interface: DictionaryService

Gets a Map of OCProperty definitions and the OCAspectDefinitions This maps a property to the aspect it comes from

Specified by:

getAspectDefinitionsByPropertyDefinition in interface DictionaryService

Returns:

updateJsonDictionary

public java.lang.String updateJsonDictionary(java.lang.String ticket,
                                             javax.servlet.http.HttpServletRequest request)

Description copied from interface: DictionaryService

Updates the dictionary json. (only used for filesystem).

Specified by:

updateJsonDictionary in interface DictionaryService

Returns:

updateDictionary

public java.lang.String updateDictionary()

Description copied from interface: DictionaryService

Refreshes the Dictionary. (only really applies to dctm).

Specified by:

updateDictionary in interface DictionaryService

Returns:

exportDictionary

public java.io.File exportDictionary()

Exports all data in the dictionary service to an XML file by calling a pojoToXml marshalling method.

Specified by:

exportDictionary in interface DictionaryService

Returns:

an XML file

pojoTypeToXml

public static java.io.File pojoTypeToXml(java.util.Collection<OCTypeDefinition> pojo)
                                  throws javax.xml.bind.JAXBException,
                                         OCException

Converts a POJO typeDefinition object to an XML object

Parameters:

pojo -

Returns:

an XML file

Throws:

javax.xml.bind.JAXBException

OCException

pojoAspectToXml

public static java.io.File pojoAspectToXml(java.util.Collection<OCAspectDefinition> pojo)
                                    throws javax.xml.bind.JAXBException,
                                           OCException

Converts a POJO aspectDefinition object to an XML object

Parameters:

pojo -

Returns:

an XML file

Throws:

javax.xml.bind.JAXBException

OCException