|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--oracle.dmt.odm.MiningObject | +--oracle.dmt.odm.settings.function.DataUsageSpecification
An instance of DataUsageSpecification
is used to specify
how the attributes in a LogicalDataSpecification
instance are used for building a mining model.
The specification may contain at most one DataUsageEntry
instance for each MiningAttribute
in the
LogicalDataSpecification
.
A mining attribute can be active, inactive, target, or supplemental.
The default usage is active
for an attribute if no
DataUsageEntry
is present.
Constructor Summary |
DataUsageSpecification()
Creates a DataUsageSpecification instance with no data usage entries
specified. |
Method Summary |
Type | Method |
---|---|
void |
addUsageEntry(DataUsageEntry entry)
Adds a DataUsageEntry to this data usage specification. |
static DataUsageSpecification |
create(LogicalDataSpecification lds,
AttributeUsage defaultAttrUsage,
DataPreparationStatus defaultDataPrep)
Creates a DataUsageSpecification instance with the specified
LogicalDataSpecification , default AttributeUsage ,
and default DataPreparationStatus for all attributes in the
LogicalDataSpecification . |
static DataUsageSpecification |
create(LogicalDataSpecification lds,
AttributeUsage defaultAttrUsage,
DataPreparationStatus defaultDataPrep,
java.lang.String targetAttrName)
Creates a DataUsageSpecification instance with the specified
LogicalDataSpecification , default AttributeUsage ,
default DataPreparationStatus , and the target attribute. |
static DataUsageSpecification |
create(MiningAttribute[] activeAttributesArray)
Deprecated. As of ODM 9.2.0. Use other create methods. |
static DataUsageSpecification |
createTargetDUS(MiningAttribute targetMiningAttribute)
Returns a DataUsageSpecification instance with the specified attribute as
a target attribute. |
DataUsageEntry[] |
getDataUsageEntries()
Returns an array of data usage entries contained in this DataUsageSpecification instance. |
DataUsageEntry |
getDataUsageEntry(java.lang.String attrName)
Returns a DataUsageEntry instance associated
with specifed named attribute. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public DataUsageSpecification()
DataUsageSpecification
instance with no data usage entries
specified.LogicalDataSpecification
Method Detail |
public void addUsageEntry(DataUsageEntry entry) throws InvalidArgumentException
DataUsageEntry
to this data usage specification.entry
- - The DataUsageEntry
InvalidArgumentException
- is thrown entry
is nullpublic DataUsageEntry[] getDataUsageEntries()
DataUsageSpecification
instance.public DataUsageEntry getDataUsageEntry(java.lang.String attrName)
DataUsageEntry
instance associated
with specifed named attribute.attName
- - The name of the attributeDataUsageEntry
with the specified attribute namepublic static DataUsageSpecification createTargetDUS(MiningAttribute targetMiningAttribute) throws InvalidArgumentException
DataUsageSpecification
instance with the specified attribute as
a target attribute. This method is useful in supervised model
building with one target attribute and remaining all attributes are
considered to be active.targetMiningAttribute
- Target MiningAttributeInvalidArgumentException
- is thrown targetMiningAttribute
is nullpublic static DataUsageSpecification create(MiningAttribute[] activeAttributesArray) throws InvalidArgumentException
create
methods.
DataUsageSpecification
that defines
the specified mining attributes as active attributes.activeAttributesArray
- An array of mining attributesDataUsageSpecification
- A created instance of data usage specificationInvalidArgumentException
- Inherited exceptionAttributeUsage
public static DataUsageSpecification create(LogicalDataSpecification lds, AttributeUsage defaultAttrUsage, DataPreparationStatus defaultDataPrep, java.lang.String targetAttrName) throws InvalidArgumentException, MiningObjectException, ODMException
DataUsageSpecification
instance with the specified
LogicalDataSpecification
, default AttributeUsage
,
default DataPreparationStatus
, and the target attribute.
It is a useful utility method to create a
DataUsageSpecification
object with the default settings
for a SupervisedFunctionSettings
lds
- logical data specificationdefaultAttrUsage
- default attribute usagedefaultDataPrep
- default data preparation statustargetAttrName
- target attribute nameInvalidArgumentException
- is thrown lds or defaultAttrUsage or defaultDataPrep or targetAttrName
is nullMiningObjectException
- is thrown public static DataUsageSpecification create(LogicalDataSpecification lds, AttributeUsage defaultAttrUsage, DataPreparationStatus defaultDataPrep) throws InvalidArgumentException, ODMException
DataUsageSpecification
instance with the specified
LogicalDataSpecification
, default AttributeUsage
,
and default DataPreparationStatus
for all attributes in the
LogicalDataSpecification
.
It is a useful utility method to create a
DataUsageSpecification
object with the default settings
for a SupervisedFunctionSettings
lds
- logical data specificationdefaultAttrUsage
- default attribute usagedefaultDataPrep
- default data preparation statusInvalidArgumentException
- is thrown lds or defaultAttrUsage or defaultDataPrep/code> is null- Since:
- ODM 9.2.0
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |