Skip navigation links

oracle.dmt.jdm.featureextraction
Class OraFeatureExtractionApplySettings

java.lang.Object
oracle.dmt.jdm.OraDMObject
oracle.dmt.jdm.OraMiningObject
oracle.dmt.jdm.task.apply.OraApplySettings
oracle.dmt.jdm.featureextraction.OraFeatureExtractionApplySettings

All Implemented Interfaces:

javax.datamining.task.apply.ApplySettings, javax.datamining.MiningObject, oracle.dmt.jdm.OraPLSQLConstants

public class OraFeatureExtractionApplySettings

extends oracle.dmt.jdm.task.apply.OraApplySettings

A OraFeatureExtractionApplySettings captures a specification that prescribes the output of an apply task specific to a feature extraction model.

Field Summary

Fields inherited from class oracle.dmt.jdm.task.apply.OraApplySettings

ALL_PREDICTIONS_APPLY_OUTPUT, DEFAULT_APPLY_OUTPUT, MULTIPLE_ROW_ALL, MULTIPLE_ROW_DEFAULT, MULTIPLE_ROW_RANKED, SINGLE_ROW_AS_SPECIFIED, TARGET_OR_CLUID_APPLY_OUTPUT, TOP_PREDICTION_APPLY_OUTPUT

Method Summary

OraFeatureExtractionApplyContent	getContent(java.lang.String destinationAttrName) Returns the apply content type designated to the specified physical attribute.
OraFeatureExtractionApplyContent[]	getContents(int rank) Returns an array of apply content types to appear in the apply output for the specified rank.
OraFeatureExtractionApplyContent[]	getContentsByFeature(int featureIdentifier) Returns the types of apply content to be included in the apply output for the specified cluser ID.
OraFeatureExtractionApplyContent[]	getMappedContents() Returns an array of apply contents that are used for mapping.
java.lang.String	getMappedDestinationAttrName(java.lang.Integer featureIdentifier, OraFeatureExtractionApplyContent contentType) Returns the name of the physical attribute mapped to the specified feature identifier.
java.lang.String	getMappedDestinationAttrName(int featureRank, OraFeatureExtractionApplyContent contentType) Returns the name of the physical attribute mapped to the specified feature identifier.
int[]	getMappedFeatureIdentifiers() Returns an array of feature identifiers mapped by mapByFeatureIdentifier method.
java.lang.Integer	getRank(java.lang.String destinationAttrName) Returns the rank designated to the specified physical attribute.
java.lang.Integer	getRanks() Returns the number of predictions specified by mapByRank method.
boolean	isFromTop() Returns true if predictions are ordered from top, false if from bottom.
void	mapByFeature(OraFeatureExtractionApplyContent content, int featureId, java.lang.String destinationAttrName) Maps the specified feature identifier to a destination attribute regardless of its rank.
void	mapByRank(OraFeatureExtractionApplyContent content, java.lang.String[] destPhysAttrNameArray, boolean fromTop) Maps the specified generated values for the predictions within the specified ranks to a set of destination attributes.
void	mapFeatures(OraFeatureExtractionApplyContent content, java.lang.String baseDestPhysAttrName) Maps all predictions in the model and the specified content value to a set of named destination attributes.
void	mapTopFeature(OraFeatureExtractionApplyContent content, java.lang.String destPhysAttrName) Maps the prediction with the highest probability to appear in the apply output under the specified attribute name.

Methods inherited from class oracle.dmt.jdm.task.apply.OraApplySettings

getAttributeNames, getContentAttrValue, getFunction, getMappedContentsEnums, getObjectType, getSourceDestinationMap, isInputObject, resetMapping, setSourceDestinationMap, verify

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.datamining.MiningObject

getCreationDate, getCreatorInfo, getDescription, getName, getObjectIdentifier, setDescription

Method Detail

getContentsByFeature

public OraFeatureExtractionApplyContent[] getContentsByFeature(int featureIdentifier)
                                                        throws javax.datamining.JDMException

Returns the types of apply content to be included in the apply output for the specified cluser ID.

Parameters:

featureIdentifier -

Returns:

OraFeatureExtractionApplyContent[]

Throws:

javax.datamining.JDMException

getMappedContents

public OraFeatureExtractionApplyContent[] getMappedContents()

Returns an array of apply contents that are used for mapping.

Returns:

OraFeatureExtractionApplyContent[]

mapByRank

public void mapByRank(OraFeatureExtractionApplyContent content,
                      java.lang.String[] destPhysAttrNameArray,
                      boolean fromTop)
               throws javax.datamining.JDMException

Maps the specified generated values for the predictions within the specified ranks to a set of destination attributes. The number of ranks depends on the cardinality of destination attributes. For example, a user may want to map the predicted target values of the top 3 prediction (rank=1,2,3) to 3 destination attributes, respectively.

Parameters:

content - A system-generated content to be included in the apply output.

destPhysAttrNameArray - An array of destination attributes.

fromTop - Indicates top predictions with the highest probabilities if true, or bottom predictions with lowest probabilities if false. If true/false, the top/bottom prediction is assigned to the first destination attribute (with index 0).

Returns:

void

Throws:

javax.datamining.JDMException

mapByFeature

public void mapByFeature(OraFeatureExtractionApplyContent content,
                         int featureId,
                         java.lang.String destinationAttrName)
                  throws javax.datamining.JDMException

Maps the specified feature identifier to a destination attribute regardless of its rank. This method is used when a specific feature is of special interest.

Parameters:

content - A system-generated content to be included in the apply output.

featureId - The feature identifier to be mapped.

destinationAttrName -

Returns:

void

Throws:

javax.datamining.JDMException

mapTopFeature

public void mapTopFeature(OraFeatureExtractionApplyContent content,
                          java.lang.String destPhysAttrName)
                   throws javax.datamining.JDMException

Maps the prediction with the highest probability to appear in the apply output under the specified attribute name.

Throws an exception if the destination attribute is duplicate.

Parameters:

content - The content type of the top prediction.

destPhysAttrName - The attribute name of the content type for the top prediction.

Returns:

void

Throws:

javax.datamining.JDMException

mapFeatures

public void mapFeatures(OraFeatureExtractionApplyContent content,
                        java.lang.String baseDestPhysAttrName)
                 throws javax.datamining.JDMException

Maps all predictions in the model and the specified content value to a set of named destination attributes. The names are created in such a way that the base destination name is suffixed with a number that starts from 1.

If the same content is used, the previous mapping is replaced with the new one.

Parameters:

content -

baseDestPhysAttrName -

Returns:

void

Throws:

javax.datamining.JDMException

getRank

public java.lang.Integer getRank(java.lang.String destinationAttrName)
                          throws javax.datamining.JDMException

Returns the rank designated to the specified physical attribute. distinationAttrName must not be null.

Parameters:

destinationAttrName - The name of the physical attribute whose designated rank is to be returned.

Returns:

Integer

Throws:

javax.datamining.JDMException

getRanks

public java.lang.Integer getRanks()

Returns the number of predictions specified by mapByRank method. Returns null if no such method has been invoked.

Returns:

Integer

isFromTop

public boolean isFromTop()

Returns true if predictions are ordered from top, false if from bottom. Returns null</n> if mapByRank method has not been invoked.

Returns:

boolean

getMappedFeatureIdentifiers

public int[] getMappedFeatureIdentifiers()

Returns an array of feature identifiers mapped by mapByFeatureIdentifier method.

Returns:

int[]

getMappedDestinationAttrName

public java.lang.String getMappedDestinationAttrName(java.lang.Integer featureIdentifier,
                                                     OraFeatureExtractionApplyContent contentType)
                                              throws javax.datamining.JDMException

Returns the name of the physical attribute mapped to the specified feature identifier. CategoryValue must not be NULL. ContentType must not be NULL.

Parameters:

featureIdentifier - The target value to be represented as the destination attribute.

contentType - The content type to be represented as the destination attribute.

Returns:

String

Throws:

javax.datamining.JDMException

getMappedDestinationAttrName

public java.lang.String getMappedDestinationAttrName(int featureRank,
                                                     OraFeatureExtractionApplyContent contentType)
                                              throws javax.datamining.JDMException

Returns the name of the physical attribute mapped to the specified feature identifier.

Parameters:

featureRank - The rank of the feature for the given content type

contentType - The content type to be represented as the destination attribute.

Returns:

String

Throws:

javax.datamining.JDMException

getContent

public OraFeatureExtractionApplyContent getContent(java.lang.String destinationAttrName)
                                            throws javax.datamining.JDMException

Returns the apply content type designated to the specified physical attribute. Name must not be NULL.

Parameters:

destinationAttrName - The name of the physical attribute whose designated content type is to be returned.

Returns:

FeatureExtractionApplyContent

Throws:

javax.datamining.JDMException

getContents

public OraFeatureExtractionApplyContent[] getContents(int rank)
                                               throws javax.datamining.JDMException

Returns an array of apply content types to appear in the apply output for the specified rank. Rank must be >= 1.

Parameters:

rank - The rank of the prediction whose content types are to be returned.

Returns:

FeatureExtractionApplyContent[]

Throws:

javax.datamining.JDMException

Skip navigation links