com.endeca.portal.model

Class Transform

java.lang.Object

com.endeca.portal.model.Transform

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

AbsTransform, AggregationTransform, BinTransform, CeilingTransform, ClusterAnalysisTransform, CustomTransform, DataTypeTransform, DeleteRowsTransform, DropColumnTransform, EntityExtractionTransform, FloorTransform, GeoHierarchyTransform, GroupTransform, JoinTransform, KeyPhrasesTransform, LowercaseTransform, NullReplaceTransform, RoundTransform, SearchableTransform, SentimentTransform, SplitTransform, TitlecaseTransform, TrimTransform, TruncateDateTransform, UppercaseTransform, WhitelistTransform

public abstract class Transform
extends java.lang.Object
implements java.io.Serializable

An abstract class representing a transform. Each child class represents an specific type of transformation, such as uppercase (UppercaseTransform). The child class should implement the logic it needs to persist user-entered data when necessary and to generate the groovy script when applicable.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	Transform.DisplayTuple Used to serialize resource string references (and their optional arguments).

Field Summary

Fields

Modifier and Type	Field and Description
protected long	applicationId
protected boolean	applied
protected java.util.Date	createdDate
protected java.lang.String	dataSetKey
protected java.util.List<TransformError>	errors
protected long	id
protected long	ordinal
protected java.util.Map<java.lang.String,java.lang.Object>	properties
protected java.lang.String	script
protected java.lang.String	sourceAttributeDisplayName
protected java.lang.String	sourceAttributeKey
protected boolean	sourceAttributeSingleAssign
protected com.oracle.endeca.pdi.concepts.MdexType	sourceAttributeType
protected java.util.List<java.lang.String>	targetAttributeDisplayNames
protected java.util.List<java.lang.String>	targetAttributeKeys
protected java.util.List<java.lang.String>	targetAttributeNotes
protected java.util.List<java.lang.String>	targetAttributeSemanticType
protected boolean	targetAttributeSingleAssign
protected java.util.List<java.util.List<java.lang.String>>	targetAttributeTags
protected com.oracle.endeca.pdi.concepts.MdexType	targetAttributeType
protected java.util.List<Column>	transformedSchema
protected TransformType	type
protected long	userId

Constructor Summary

Constructors

Constructor and Description
Transform()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
protected static java.lang.String	escapeQuotes(java.lang.String sourceString)
long	getApplicationId()
java.util.Date	getCreatedDate()
java.lang.String	getDataSetKey()
abstract Transform.DisplayTuple	getDisplayTuple() Get serialized resource string references (and their optional arguments).
java.util.List<TransformError>	getErrors() This list of errors is a transient property for collecting errors as they are found by the validator.
java.lang.String	getFirstTargetAttributeDisplayName()
java.lang.String	getFirstTargetAttributeKey()
long	getId()
java.util.Map<java.lang.String,java.lang.Object>	getJsonProperties()
static com.oracle.endeca.pdi.concepts.MdexType	getMdexDataType(java.lang.String type)
long	getOrdinal()
java.util.List<TransformInfo>	getPreviewTransforms() Returns a list of Preview API transforms.
java.util.Map<java.lang.String,java.lang.Object>	getProperties()
java.lang.Object	getProperty(java.lang.String key)
java.lang.String	getSafeSourceAttributeRef()
java.lang.String	getScript() This script property differs from the groovy script that is returned by toScript().
java.lang.String	getSourceAttributeDisplayName()
java.lang.String	getSourceAttributeKey()
boolean	getSourceAttributeSingleAssign()
com.oracle.endeca.pdi.concepts.MdexType	getSourceAttributeType()
java.lang.String	getSourceAttributeTypeDeserialize()
java.util.List<java.lang.String>	getTargetAttributeDisplayNames()
java.util.List<java.lang.String>	getTargetAttributeKeys()
java.util.List<java.lang.String>	getTargetAttributeNotes()
java.util.List<java.lang.String>	getTargetAttributeSemanticType()
boolean	getTargetAttributeSingleAssign()
java.util.List<java.util.List<java.lang.String>>	getTargetAttributeTags()
com.oracle.endeca.pdi.concepts.MdexType	getTargetAttributeType() The attribute type of the attribute(s) created by this transform.
java.lang.String	getTargetAttributeTypeDeserialize()
java.util.List<Column>	getTransformedSchema() This transformed schema is a transient property used for validation.
java.util.Map<java.lang.String,Column>	getTransformedSchemaMap() A map of the above mentioned transform schema.
TransformType	getType()
long	getUserId()
java.util.List<TransformInfo>	getWorkflowManagerTransforms() Converts preview service transforms represented by this Transform into the corresponding Workflow Manager API model objects.
boolean	isApplied()
boolean	isValid()
void	setApplicationId(long applicationId)
void	setApplied(boolean applied)
void	setCreatedDate(java.util.Date createdDate)
void	setDataSetKey(java.lang.String dataSetKey)
void	setErrors(java.util.List<TransformError> errors)
void	setId(long id)
void	setOrdinal(long ordinal)
void	setProperties(java.util.Map<java.lang.String,java.lang.Object> properties)
void	setProperty(java.lang.String key, java.lang.Object value)
void	setScript(java.lang.String script)
void	setSourceAttributeDisplayName(java.lang.String sourceAttributeDisplayName)
void	setSourceAttributeKey(java.lang.String sourceAttributeKey)
void	setSourceAttributeSingleAssign(boolean singleAssign)
void	setSourceAttributeType(com.oracle.endeca.pdi.concepts.MdexType sourceAttributeType)
void	setSourceAttributeType(java.lang.String sourceAttributeType)
void	setSourceAttributeTypeSerialize(java.lang.String sourceAttributeType)
void	setTargetAttributeDisplayNames(java.util.List<java.lang.String> targetAttributeDisplayNames)
void	setTargetAttributeKeys(java.util.List<java.lang.String> targetAttributeKeys)
void	setTargetAttributeNotes(java.util.List<java.lang.String> targetAttributeNotes)
void	setTargetAttributeSemanticType(java.util.List<java.lang.String> targetAttributeSemanticType)
void	setTargetAttributeSingleAssign(boolean singleAssign)
void	setTargetAttributeTags(java.util.List<java.util.List<java.lang.String>> targetAttributeTags)
void	setTargetAttributeType(com.oracle.endeca.pdi.concepts.MdexType targetAttributeType)
void	setTargetAttributeType(java.lang.String targetAttributeType)
void	setTargetAttributeTypeSerialize(java.lang.String targetAttributeType)
void	setTransformedSchema(java.util.List<Column> transformedSchema)
void	setType(TransformType type)
void	setUserId(long userId)
abstract java.lang.String	toScript() Converts the transform into a groovy script.
abstract java.util.List<TransformError>	validate() Validates a transform.
java.util.List<TransformError>	validateGroovy() Validates the Groovy for a transform.
java.util.List<TransformError>	validateSourceAttribute(com.oracle.endeca.pdi.concepts.MdexType expectedType, java.lang.Boolean expectedSingleAssign) Validates that a source attribute exists in the transformedSchemaMap.

Methods inherited from class java.lang.Object

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

Field Detail

id

protected long id

applicationId

protected long applicationId

dataSetKey

protected java.lang.String dataSetKey

sourceAttributeDisplayName

protected java.lang.String sourceAttributeDisplayName

targetAttributeNotes

protected java.util.List<java.lang.String> targetAttributeNotes

targetAttributeSemanticType

protected java.util.List<java.lang.String> targetAttributeSemanticType

targetAttributeTags

protected java.util.List<java.util.List<java.lang.String>> targetAttributeTags

targetAttributeDisplayNames

protected java.util.List<java.lang.String> targetAttributeDisplayNames

sourceAttributeKey

protected java.lang.String sourceAttributeKey

targetAttributeKeys

protected java.util.List<java.lang.String> targetAttributeKeys

type

protected TransformType type

applied

protected boolean applied

userId

protected long userId

createdDate

protected java.util.Date createdDate

ordinal

protected long ordinal

script

protected java.lang.String script

sourceAttributeSingleAssign

protected boolean sourceAttributeSingleAssign

targetAttributeSingleAssign

protected boolean targetAttributeSingleAssign

sourceAttributeType

protected com.oracle.endeca.pdi.concepts.MdexType sourceAttributeType

targetAttributeType

protected com.oracle.endeca.pdi.concepts.MdexType targetAttributeType

transformedSchema

protected transient java.util.List<Column> transformedSchema

errors

protected transient java.util.List<TransformError> errors

properties

protected java.util.Map<java.lang.String,java.lang.Object> properties

Constructor Detail

Transform

public Transform()

Method Detail

getId

public long getId()

setId

public void setId(long id)

getApplicationId

public long getApplicationId()

setApplicationId

public void setApplicationId(long applicationId)

getDataSetKey

public java.lang.String getDataSetKey()

setDataSetKey

public void setDataSetKey(java.lang.String dataSetKey)

getSourceAttributeKey

public java.lang.String getSourceAttributeKey()

setSourceAttributeKey

public void setSourceAttributeKey(java.lang.String sourceAttributeKey)

getFirstTargetAttributeKey

public java.lang.String getFirstTargetAttributeKey()

getFirstTargetAttributeDisplayName

public java.lang.String getFirstTargetAttributeDisplayName()

getTargetAttributeKeys

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

setTargetAttributeKeys

public void setTargetAttributeKeys(java.util.List<java.lang.String> targetAttributeKeys)

getType

public TransformType getType()

setType

public void setType(TransformType type)

isApplied

public boolean isApplied()

setApplied

public void setApplied(boolean applied)

getSourceAttributeSingleAssign

public boolean getSourceAttributeSingleAssign()

setSourceAttributeSingleAssign

public void setSourceAttributeSingleAssign(boolean singleAssign)

getTargetAttributeSingleAssign

public boolean getTargetAttributeSingleAssign()

setTargetAttributeSingleAssign

public void setTargetAttributeSingleAssign(boolean singleAssign)

getTargetAttributeType

public com.oracle.endeca.pdi.concepts.MdexType getTargetAttributeType()

The attribute type of the attribute(s) created by this transform. Most child classes will override this method, setting the known attribute type of its intended output. For example, an UppercaseTransform will always return an mdex:string. A DateConversionTransform basis its target attribute type on which type the user chooses to convert to. This default implementation is used for those transforms that specify their output attribute type in javascript. The targetAttributeType property can be set, which is persisted into this variable and used to determine the attribute type.

Returns:

setTargetAttributeType

public void setTargetAttributeType(com.oracle.endeca.pdi.concepts.MdexType targetAttributeType)

setTargetAttributeType

public void setTargetAttributeType(java.lang.String targetAttributeType)

getTargetAttributeTypeDeserialize

public java.lang.String getTargetAttributeTypeDeserialize()

setTargetAttributeTypeSerialize

public void setTargetAttributeTypeSerialize(java.lang.String targetAttributeType)

getUserId

public long getUserId()

setUserId

public void setUserId(long userId)

getOrdinal

public long getOrdinal()

setCreatedDate

public void setCreatedDate(java.util.Date createdDate)

setOrdinal

public void setOrdinal(long ordinal)

getCreatedDate

public java.util.Date getCreatedDate()

getScript

public java.lang.String getScript()

This script property differs from the groovy script that is returned by toScript(). This property stores a user-entered groovy script for those transforms that allow such input (e.g. custom transforms and filter row transforms).

setScript

public void setScript(java.lang.String script)

getProperties

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

getJsonProperties

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

setProperties

public void setProperties(java.util.Map<java.lang.String,java.lang.Object> properties)

getProperty

public java.lang.Object getProperty(java.lang.String key)

setProperty

public void setProperty(java.lang.String key,
               java.lang.Object value)

getSourceAttributeDisplayName

public java.lang.String getSourceAttributeDisplayName()

setSourceAttributeDisplayName

public void setSourceAttributeDisplayName(java.lang.String sourceAttributeDisplayName)

getTargetAttributeNotes

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

setTargetAttributeNotes

public void setTargetAttributeNotes(java.util.List<java.lang.String> targetAttributeNotes)

getTargetAttributeSemanticType

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

setTargetAttributeTags

public void setTargetAttributeTags(java.util.List<java.util.List<java.lang.String>> targetAttributeTags)

getTargetAttributeTags

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

setTargetAttributeSemanticType

public void setTargetAttributeSemanticType(java.util.List<java.lang.String> targetAttributeSemanticType)

getTargetAttributeDisplayNames

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

setTargetAttributeDisplayNames

public void setTargetAttributeDisplayNames(java.util.List<java.lang.String> targetAttributeDisplayNames)

isValid

public boolean isValid()

getSourceAttributeType

public com.oracle.endeca.pdi.concepts.MdexType getSourceAttributeType()

setSourceAttributeType

public void setSourceAttributeType(com.oracle.endeca.pdi.concepts.MdexType sourceAttributeType)

setSourceAttributeType

public void setSourceAttributeType(java.lang.String sourceAttributeType)

getSourceAttributeTypeDeserialize

public java.lang.String getSourceAttributeTypeDeserialize()

setSourceAttributeTypeSerialize

public void setSourceAttributeTypeSerialize(java.lang.String sourceAttributeType)

getErrors

public java.util.List<TransformError> getErrors()

This list of errors is a transient property for collecting errors as they are found by the validator.

setErrors

public void setErrors(java.util.List<TransformError> errors)

getTransformedSchema

public java.util.List<Column> getTransformedSchema()

This transformed schema is a transient property used for validation. The schema of each transform is calculated prior to validation and set into this variable. The schema represents the list of columns that existed before the current transform has executed.

getTransformedSchemaMap

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

A map of the above mentioned transform schema.

setTransformedSchema

public void setTransformedSchema(java.util.List<Column> transformedSchema)

getSafeSourceAttributeRef

public java.lang.String getSafeSourceAttributeRef()

toScript

public abstract java.lang.String toScript()

Converts the transform into a groovy script. Each child class should implement this method with its own logic. Certain transforms, such as joins and aggregations, have no need for groovy. In these cases, the override should simply return null.

getWorkflowManagerTransforms

public java.util.List<TransformInfo> getWorkflowManagerTransforms()

Converts preview service transforms represented by this Transform into the corresponding Workflow Manager API model objects.

getPreviewTransforms

public java.util.List<TransformInfo> getPreviewTransforms()

Returns a list of Preview API transforms. This default implementation should be adequate for any transform that creates only a single column. If a child class should create multiple transforms from its metadata, this method should be overridden.

validate

public abstract java.util.List<TransformError> validate()

Validates a transform. This method should be overridden by each child class. Convenience methods are provided to validate source attributes and Groovy for transforms that don't require special validation.

Returns:

validateSourceAttribute

public java.util.List<TransformError> validateSourceAttribute(com.oracle.endeca.pdi.concepts.MdexType expectedType,
                                                     java.lang.Boolean expectedSingleAssign)

Validates that a source attribute exists in the transformedSchemaMap. Also validates the data type and single assign-ness of the source attribute when applicable.

Parameters:

expectedTypes - Expected MdexType. Leave null if the attribute type of the source does not matter.

expectedSingleAssign - Expected single assign boolean. Leave null if the the transform will work just as well either way.

validateGroovy

public java.util.List<TransformError> validateGroovy()

Validates the Groovy for a transform.

getDisplayTuple

public abstract Transform.DisplayTuple getDisplayTuple()

Get serialized resource string references (and their optional arguments). This method should be overridden by each child class.

getMdexDataType

public static com.oracle.endeca.pdi.concepts.MdexType getMdexDataType(java.lang.String type)

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

escapeQuotes

protected static java.lang.String escapeQuotes(java.lang.String sourceString)