oracle.odi.domain.project

Class OdiKMTemplate

java.lang.Object

oracle.odi.domain.support.BusinessObject

oracle.odi.domain.support.AbstractRepositoryEntity

oracle.odi.domain.support.AbstractOdiEntity

oracle.odi.domain.project.OdiKMTemplate

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, oracle.odi.core.audit.support.IAuditableFirstClassObject, IModelObject, IModelObjectBase, ITemplate, oracle.odi.domain.impexp.IExportable, IOdiEntity, IRepositoryEntity, IWorkDevelopmentOdiEntity, oracle.odi.impexp.smartie.ISmartExportable

public class OdiKMTemplate
extends oracle.odi.domain.support.AbstractOdiEntity
implements IWorkDevelopmentOdiEntity, oracle.odi.domain.impexp.IExportable, oracle.odi.impexp.smartie.ISmartExportable, oracle.odi.core.audit.support.IAuditableFirstClassObject, ITemplate

See Also:

Serialized Form

Field Summary

Fields inherited from class oracle.odi.domain.support.AbstractOdiEntity

STARTING_INTERNAL_VERSION

Constructor Summary

Constructors

Constructor and Description
OdiKMTemplate(java.lang.String templateName) Constructs a new OdiKMTemplate
OdiKMTemplate(java.lang.String templateName, OdiTechnology technology, oracle.odi.domain.topology.language.OdiLanguage baseLanguage) Constructs a new OdiKMTemplate

Method Summary

Modifier and Type	Method and Description
OdiKMTemplateTemplateJoin	addOdiKMTemplateReference(OdiKMTemplate odiKMTemplate) Adds the {link OdiKMTemplate}'s reference to this OdiKMTemplate.
oracle.odi.domain.topology.language.OdiLanguage	getBaseLanguage() Obtains the base language for which this OdiKMTemplate is designed to be used.
java.lang.String	getBaseLanguageName() Get the base language name associated with this template.
java.lang.String	getDomainInterfaceType()
java.io.Serializable	getInternalId() Provides a common getter for the persistence layer to obtain an identity, irrespective of the actual type of identity used.
java.util.List	getKms() Returns the KMs that are referencing this OdiKMTemplate.
java.lang.String	getName() Returns the name of this entity instance.
java.util.List	getOdiKMTemplateReferenceList() Returns the list of OdiKMTemplate's that are referenced by this OdiKMTemplate.
java.util.List	getOdiKMTemplateReferredList() Returns the list of OdiKMTemplate's that are referred by this OdiKMTemplate.
java.util.List	getOdiKMTemplateRefferedList() Returns the list of OdiKMTemplate's that are referenced by this OdiKMTemplate.
java.lang.String	getQualifiedName()
OdiTechnology	getTechnology() Obtains the technology for which this OdiKMTemplate is designed to be used.
java.lang.String	getTechnologyName() Gets the technology name associated with this template.
java.lang.Number	getTemplateId() Obtains the Id for this OdiKMTemplate.
java.lang.String	getTemplateName() Obtains the name of this OdiKMTemplate.
java.lang.String	getTemplateText() Obtains the text of the template.
boolean	isFromInclude() If true, indicates that this template declaration was generated by expanding an INCLUDE command.
boolean	isGeneric() Checks if this template applies to all (generic) technologies.
boolean	isReplicateNewlines() If true, indicates that the newline characters in this template are intended to be reproduced in the generated code.
boolean	isSeeded() Returns whether this OdiKMTemplate is seeded or not.
OdiKMTemplateTemplateJoin	removeOdiKMTemplateReference(OdiKMTemplate odiKMTemplate) Removes the {link OdiKMTemplate}'s reference from this OdiKMTemplate.
void	setBaseLanguage(oracle.odi.domain.topology.language.OdiLanguage baseLanguage) Obtains the base language for which this OdiKMTemplate is designed to be used.
void	setIsReplicateNewlines(boolean value)
void	setTechnology(OdiTechnology technology) Specifies the technology for which this OdiKMTemplate is designed to be used.
void	setTemplateName(java.lang.String templateName) Specifies the name of this OdiKMTemplate.
void	setTemplateText(java.lang.String templateText) Specifies the text of the template.
java.lang.String	toString()

Methods inherited from class oracle.odi.domain.support.AbstractOdiEntity

getFirstDate, getFirstUser, getInternalVersion, getLastDate, getLastUser, isInstanceLevelSecurityNeeded, isNew, preCommit

Methods inherited from class oracle.odi.domain.support.AbstractRepositoryEntity

equals, getBigNumericId, getGlobalId, getNumericId, getParent, hashCode

Methods inherited from class oracle.odi.domain.support.BusinessObject

clone

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.odi.domain.IOdiEntity

getFirstDate, getFirstUser, getLastDate, getLastUser, isInstanceLevelSecurityNeeded

Methods inherited from interface oracle.odi.domain.IRepositoryEntity

getGlobalId, getParent

Methods inherited from interface oracle.odi.domain.adapter.IModelObjectBase

getBigNumericId, getGlobalId, getNumericId

Constructor Detail

OdiKMTemplate

public OdiKMTemplate(java.lang.String templateName)

Constructs a new OdiKMTemplate

Parameters:

templateName - - the name of the template

OdiKMTemplate

public OdiKMTemplate(java.lang.String templateName,
                     OdiTechnology technology,
                     oracle.odi.domain.topology.language.OdiLanguage baseLanguage)

Constructs a new OdiKMTemplate

Parameters:

templateName - - the name of the template

technology - - the technology for which this template is designed to be used.

baseLanguage - - The base language for which this template is designed to be used.

Method Detail

getTemplateId

public java.lang.Number getTemplateId()

Obtains the Id for this OdiKMTemplate.

Returns:

the templateId

getTemplateName

public java.lang.String getTemplateName()

Obtains the name of this OdiKMTemplate.

Returns:

the templateName

getName

public java.lang.String getName()

Description copied from interface: IOdiEntity

Returns the name of this entity instance.

Specified by:

getName in interface IModelObject

Specified by:

getName in interface IOdiEntity

Overrides:

getName in class oracle.odi.domain.support.AbstractOdiEntity

Returns:

the name

setTemplateName

public void setTemplateName(java.lang.String templateName)

Specifies the name of this OdiKMTemplate.

Parameters:

templateName - the templateName to set

getTechnology

public OdiTechnology getTechnology()

Obtains the technology for which this OdiKMTemplate is designed to be used.

Returns:

the technology

setTechnology

public void setTechnology(OdiTechnology technology)

Specifies the technology for which this OdiKMTemplate is designed to be used.

Parameters:

technology - the technology to set

getBaseLanguage

public oracle.odi.domain.topology.language.OdiLanguage getBaseLanguage()

Obtains the base language for which this OdiKMTemplate is designed to be used.

Returns:

the baseLanguage

setBaseLanguage

public void setBaseLanguage(oracle.odi.domain.topology.language.OdiLanguage baseLanguage)

Obtains the base language for which this OdiKMTemplate is designed to be used.

Parameters:

baseLanguage - the baseLanguage to set

isSeeded

public boolean isSeeded()

Returns whether this OdiKMTemplate is seeded or not.

Returns:

true if this OdiKMTemplate is seeded, false otherwise

getTemplateText

public java.lang.String getTemplateText()

Obtains the text of the template.

Specified by:

getTemplateText in interface ITemplate

Returns:

the templateText

setTemplateText

public void setTemplateText(java.lang.String templateText)

Specifies the text of the template.

Parameters:

templateText - the templateText to set

setIsReplicateNewlines

public void setIsReplicateNewlines(boolean value)

getKms

public java.util.List getKms()

Returns the KMs that are referencing this OdiKMTemplate.

Returns:

unmodifiable list of kms

getInternalId

public java.io.Serializable getInternalId()

Description copied from interface: IRepositoryEntity

Provides a common getter for the persistence layer to obtain an identity, irrespective of the actual type of identity used.

Typically a subclass will delegate to a public SomePrimitiveWrapper getId() method. The necessity for the getInternalId() abstract method is solely because the persistence layer needs a way of obtaining the identity irrespective of the actual identity implementation choice.

Returning null from this method will indicate the object has never been saved. This will likely be relied on by some DAO implementations.

Specified by:

getInternalId in interface IRepositoryEntity

Returns:

the persistence identity of this instance

getQualifiedName

public java.lang.String getQualifiedName()

Specified by:

getQualifiedName in interface IModelObject

Returns:

fully qualified name of this object.

getDomainInterfaceType

public java.lang.String getDomainInterfaceType()

Specified by:

getDomainInterfaceType in interface IModelObjectBase

Returns:

full class name

isGeneric

public boolean isGeneric()

Description copied from interface: ITemplate

Checks if this template applies to all (generic) technologies.

Specified by:

isGeneric in interface ITemplate

Returns:

true if template is for all technologies, false otherwise

isFromInclude

public boolean isFromInclude()

Description copied from interface: ITemplate

If true, indicates that this template declaration was generated by expanding an INCLUDE command.

Specified by:

isFromInclude in interface ITemplate

Returns:

isReplicateNewlines

public boolean isReplicateNewlines()

Description copied from interface: ITemplate

If true, indicates that the newline characters in this template are intended to be reproduced in the generated code. If false, newlines must be explicitly specified using the {#NL#} template command.

Specified by:

isReplicateNewlines in interface ITemplate

toString

public java.lang.String toString()

Overrides:

toString in class oracle.odi.domain.support.AbstractOdiEntity

getBaseLanguageName

public java.lang.String getBaseLanguageName()

Description copied from interface: ITemplate

Get the base language name associated with this template.

Specified by:

getBaseLanguageName in interface ITemplate

Returns:

getTechnologyName

public java.lang.String getTechnologyName()

Description copied from interface: ITemplate

Gets the technology name associated with this template.

Specified by:

getTechnologyName in interface ITemplate

Returns:

the technology name

addOdiKMTemplateReference

public OdiKMTemplateTemplateJoin addOdiKMTemplateReference(OdiKMTemplate odiKMTemplate)

Adds the {link OdiKMTemplate}'s reference to this OdiKMTemplate.

Parameters:

odiKMTemplate - the KM template to be added

getOdiKMTemplateReferenceList

public java.util.List getOdiKMTemplateReferenceList()

Returns the list of OdiKMTemplate's that are referenced by this OdiKMTemplate.

Returns:

unmodifiable list of OdiKMTemplates

getOdiKMTemplateRefferedList

public java.util.List getOdiKMTemplateRefferedList()

Returns the list of OdiKMTemplate's that are referenced by this OdiKMTemplate.

Returns:

unmodifiable list of OdiKMTemplates

getOdiKMTemplateReferredList

public java.util.List getOdiKMTemplateReferredList()

Returns the list of OdiKMTemplate's that are referred by this OdiKMTemplate.

Returns:

unmodifiable list of OdiKMTemplates

removeOdiKMTemplateReference

public OdiKMTemplateTemplateJoin removeOdiKMTemplateReference(OdiKMTemplate odiKMTemplate)

Removes the {link OdiKMTemplate}'s reference from this OdiKMTemplate.

Parameters:

odiKMTemplate - the KM template reference to be removed