oracle.ifs.core.extraction.beans

Class InformationExtractionTrainingSetDefinition

java.lang.Object

oracle.ifs.beans.LibraryObjectDefinition

oracle.ifs.beans.PublicObjectDefinition

oracle.ifs.beans.ApplicationObjectDefinition

oracle.ifs.core.extraction.beans.InformationExtractionTrainingSetDefinition

All Implemented Interfaces:

Serializable, Cloneable

public class InformationExtractionTrainingSetDefinition
extends ApplicationObjectDefinition

A InformationExtractionTrainingSetDefinition is used to create or modify a InformationExtractionTrainingSet instance.

Author:

Dave Long

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class oracle.ifs.beans.LibraryObjectDefinition

LibraryObjectDefinition.EnumToIntegerCode, LibraryObjectDefinition.LookupByName

Field Summary

Fields inherited from class oracle.ifs.beans.LibraryObjectDefinition

m_Attributes, m_ClassObjectName, m_ClassObjectValue, m_ContentSpecifications, m_DefinitionLists, m_Definitions, m_EnclosedDefinition, m_Id, m_Options, m_ReadOnly, m_ReferenceAttributes, m_Session, m_SystemOptions

Constructor Summary

Constructors

Constructor and Description
InformationExtractionTrainingSetDefinition(LibrarySessionInterface session) Constructs a definition explicitly capturing the session.
InformationExtractionTrainingSetDefinition(LibrarySessionInterface session, String className) Constructs a definition explicitly capturing the session, and setting the initial ClassObject.

Method Summary

Modifier and Type	Method and Description
void	applySettings(AttributeValueTable avt) Applies settings from the specified table.
SimplePropertyTableListDefinition	getResultsDefinition() Gets the SimplePropertyTableListDefinition definition for the results list.
void	setResultsDefinition(SimplePropertyTableListDefinition def) Sets the SimplePropertyTableListDefinition definition for the results list.
static InformationExtractionTrainingSetDefinition	toInformationExtractionTrainingSetDefinition(LibraryObjectDefinition lodef) Casts the specified LibraryObjectDefinition to a InformationExtractionTrainingSetDefinition.
static InformationExtractionTrainingSetDefinition	toInformationExtractionTrainingSetDefinition(LibraryObjectDefinition lodef, boolean enforce) Casts the specified LibraryObjectDefinition to a InformationExtractionTrainingSetDefinition.

Methods inherited from class oracle.ifs.beans.PublicObjectDefinition

addCategoryDefinition, addCategoryDefinition, addCategoryDefinitions, addCategoryDefinitions, getAddToFolderOption, getAddToFolderValue, getAutoFolderingActionSpecification, getCascadeCopyRelationshipsOption, getCascadeCopyRelationshipsOptionValue, getCategoryCopyOption, getCategoryDefinitions, getContentQuotaCopyOption, getCreateCategoriesServerSideOption, getExplicitCreateAndModifyAttributesOption, getExplicitCreateDate, getExplicitLastModifyDate, getFreeIfLastFolderReferenceOption, getKeepLastModifierOption, getKeepLastModifyDateOption, getLockEntryDefinition, getLockObject, getLockObjectDefinition, getLockObjectValue, getSecuringPublicObject, getSecuringPublicObjectValue, getUpdatedLockObjectDefinition, removeCategoryDefinitions, removeLockEntryDefinition, resolveAutoFolderingSettings, setAddToFolderOption, setAddToFolderValue, setAutoFolderingActionSpecification, setAutoFolderingActionSpecification, setCascadeCopyRelationshipsOption, setCategoryCopyOption, setCategoryDefinitions, setContentQuotaCopyOption, setCreateCategoriesServerSideOption, setExplicitCreateAndModifyAttributesOption, setExplicitCreateDate, setExplicitLastModifyDate, setFreeIfLastFolderReferenceOption, setKeepLastModifierOption, setKeepLastModifyDateOption, setLockEntryDefinition, setLockObject, setLockObjectDefinition, setLockObjectValue, setNullSecurity, setPrivateSecurity, setPublishedSecurity, setSecuringPublicObject, setSecuringPublicObjectValue, setUpdatedLockObjectDefinition, toPublicObjectDefinition, toPublicObjectDefinition

Methods inherited from class oracle.ifs.beans.LibraryObjectDefinition

addDefinition, addDefinitions, addProperty, addPropertyDefinition, addPropertyDefinition, addPropertyDefinitions, addPropertyDefinitions, addSimplePropertyDefinition, addSimplePropertyDefinition, addSimplePropertyDefinitions, addSimplePropertyDefinitions, applyEnumSetting, applyEnumSetting, applyMapSetting, applyMapSetting, applyObjectArraySetting, applyObjectArraySetting, applyObjectSetting, applyObjectSetting, applySetting, applySetting, captureSession, captureSession, captureSession, clone, constructInstance, constructInstance, constructInstance, copyInto, deriveObjectArraySetting, deriveObjectSetting, getAttribute, getAttribute, getAttributes, getAttributes, getAttributesSorted, getClassId, getClassObject, getClassObjectValue, getContentSpecification, getContentSpecificationKeys, getCopiedObjectValue, getDefinition, getDefinitionClassName, getDefinitionKeys, getDefinitionListKeys, getDefinitions, getId, getLibrarySession, getName, getOption, getOptionAsAttributeValue, getOptionKeys, getPolicyMode, getPropertyDefinitions, getReferenceAttribute, getReferenceAttributes, getServerDefinition, getSession, getSimplePropertyDefinitions, getSLibrarySession, getStringAttribute, getSystemOption, getSystemOptionAsAttributeValue, getSystemOptionAsBoolean, getSystemOptionKeys, getWriteableInstance, isReadOnly, prepareForDefinitionObject, processSimplePropertiesForCreate, processSimplePropertiesForUpdate, removeAttribute, removeContentSpecification, removeDefinition, removeDefinitions, removeOption, removePropertyDefinitions, removeReferenceAttribute, removeSimplePropertyDefinitions, removeSystemOption, reset, resolve, setAttribute, setAttribute, setAttribute, setAttributeByUpperCaseName, setAttributeByUpperCaseName, setAttributePolicyMode, setAttributes, setClassId, setClassname, setClassObject, setClassObjectValue, setContentSpecification, setCopiedObjectValue, setDefinition, setDefinitions, setId, setName, setOption, setReadOnly, setReferenceAttribute, setReferenceAttribute, setSession, setSimplePropertyDefinitions, setSystemOption, unresolve, verifySession

Methods inherited from class java.lang.Object

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

Constructor Detail

InformationExtractionTrainingSetDefinition

public InformationExtractionTrainingSetDefinition(LibrarySessionInterface session)
                                           throws IfsException

Constructs a definition explicitly capturing the session.

The initial ClassObject will be InformationExtractionTrainingSet.

Parameters:

session - the session context

Throws:

IfsException - if the operation fails

InformationExtractionTrainingSetDefinition

public InformationExtractionTrainingSetDefinition(LibrarySessionInterface session,
                                                  String className)
                                           throws IfsException

Constructs a definition explicitly capturing the session, and setting the initial ClassObject.

Parameters:

session - the session context

className - the initial class name

Throws:

IfsException - if the operation fails

Method Detail

applySettings

public void applySettings(AttributeValueTable avt)
                   throws IfsException

Applies settings from the specified table.

Overrides:

applySettings in class PublicObjectDefinition

Parameters:

avt - the table having the definition settings

Throws:

IfsException - if the operation fails

(Published)

setResultsDefinition

public void setResultsDefinition(SimplePropertyTableListDefinition def)
                          throws IfsException

Sets the SimplePropertyTableListDefinition definition for the results list.

Parameters:

def - the definition for the SimplePropertyTableList

Throws:

IfsException - if the operation fails

(Published)

getResultsDefinition

public SimplePropertyTableListDefinition getResultsDefinition()
                                                       throws IfsException

Gets the SimplePropertyTableListDefinition definition for the results list.

Returns:

the definition for the SimplePropertyTableList

Throws:

IfsException - if the operation fails

(Published)

toInformationExtractionTrainingSetDefinition

public static InformationExtractionTrainingSetDefinition toInformationExtractionTrainingSetDefinition(LibraryObjectDefinition lodef)
                                                                                               throws IfsException

Casts the specified LibraryObjectDefinition to a InformationExtractionTrainingSetDefinition.

Returns null if the specified definition is not a InformationExtractionTrainingSetDefinition, or if the specified definition is null.

Parameters:

lodef - the definition to be casted

Returns:

a properly casted definition

Throws:

IfsException - if the operation fails

toInformationExtractionTrainingSetDefinition

public static InformationExtractionTrainingSetDefinition toInformationExtractionTrainingSetDefinition(LibraryObjectDefinition lodef,
                                                                                                      boolean enforce)
                                                                                               throws IfsException

Casts the specified LibraryObjectDefinition to a InformationExtractionTrainingSetDefinition.

Returns null if the specified definition is null. If non-null and unable to cast, returns null if enforceCompat is false but throws an IfsException if the specified definition is not an InformationExtractionTrainingSetDefinition.

Parameters:

lodef - the definition to be casted

enforce - whether to throw an exception if a non-null definition cannot be cast

Returns:

a properly casted definition

Throws:

IfsException - if the operation fails