oracle.ifs.core.extraction.beans

Class InformationExtractionDomainSpecificationDefinition

java.lang.Object

oracle.ifs.beans.LibraryObjectDefinition

oracle.ifs.beans.SystemObjectDefinition

oracle.ifs.core.extraction.beans.InformationExtractionAbstractSpecificationDefinition

oracle.ifs.core.extraction.beans.InformationExtractionDomainSpecificationDefinition

All Implemented Interfaces:

Serializable, Cloneable

public class InformationExtractionDomainSpecificationDefinition
extends InformationExtractionAbstractSpecificationDefinition

A InformationExtractionDomainSpecificationDefinition is used to create or modify a InformationExtractionDomainSpecification instance.

Author:

Dave Long

See Also:

Serialized Form

(Published)

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.core.extraction.beans.InformationExtractionAbstractSpecificationDefinition

SETTINGS_ATTRIBUTE

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
InformationExtractionDomainSpecificationDefinition(LibrarySessionInterface session) Constructs a definition explicitly capturing the session.
InformationExtractionDomainSpecificationDefinition(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	addEntityPhraseDefinition(AttributeValueTable avt) Adds a new InformationExtractionEntityPhraseDefinition for an InformationExtractionEntityPhrase specified in a table.
void	addEntityPhraseDefinition(InformationExtractionEntityPhraseDefinition def) Adds a new EntityPhrase definition for an EntityPhrase.
void	addEntityPhraseDefinitions(InformationExtractionEntityPhraseDefinition[] defs) Adds a set of EntityPhrase definitions for multiple EntityPhrases.
void	addEntityPhraseDefinitions(List<AttributeValueTable> entPhrasesList) Adds new InformationExtractionEntityPhraseDefinitions for a table list of InformationExtractionEntityPhrases.
void	addEntityRelationTypeDefinition(AttributeValueTable avt) Adds a new InformationExtractionEntityTypeDefinition for a EntityRelationType specified in a table.
void	addEntityRelationTypeDefinition(InformationExtractionEntityRelationTypeDefinition def) Adds a new EntityRelationType definition for an EntityRelationType.
void	addEntityRelationTypeDefinitions(InformationExtractionEntityRelationTypeDefinition[] defs) Adds a set of EntityRelationType definitions for multiple EntityRelationTypes.
void	addEntityRelationTypeDefinitions(List<AttributeValueTable> entRelTypesList) Adds new InformationExtractionEntityRelationTypeDefinitions for a table list of EntityRelationTypes.
void	addEntityTypeDefinition(AttributeValueTable avt) Adds a new InformationExtractionEntityTypeDefinition for a EntityType specified in a table.
void	addEntityTypeDefinition(InformationExtractionEntityTypeDefinition def) Adds a new EntityType definition for an EntityType.
void	addEntityTypeDefinitions(InformationExtractionEntityTypeDefinition[] defs) Adds a set of EntityType definitions for multiple EntityTypes.
void	addEntityTypeDefinitions(List<AttributeValueTable> entTypesList) Adds new InformationExtractionEntityTypeDefinitions for a table list of EntityTypes.
void	addImplicitEntityRelationDefinition(AttributeValueTable avt) Adds a new InformationExtractionImplicitEntityRelationDefinition for a Implicit Entity Relation specified in a table.
void	addImplicitEntityRelationDefinition(InformationExtractionImplicitEntityRelationDefinition def) Adds a new ImplicitEntityRelation definition for an ImplicitEntityRelation.
void	addImplicitEntityRelationDefinitions(InformationExtractionImplicitEntityRelationDefinition[] defs) Adds a set of ImplicitEntityRelation definitions for multiple ImplicitEntityRelations.
void	addImplicitEntityRelationDefinitions(List<AttributeValueTable> implEntRelsList) Adds new InformationExtractionImplicitEntityRelationDefinitions for a table list of Implicit Entity Relations.
void	addLegalEntityRelationDefinition(AttributeValueTable avt) Adds a new definition for a Legal Entity Relation specified in a table.
void	addLegalEntityRelationDefinition(InformationExtractionLegalEntityRelationDefinition def) Adds a new legal EntityRelation definition for an InformationExtractionLegalEntityRelation.
void	addLegalEntityRelationDefinitions(InformationExtractionLegalEntityRelationDefinition[] defs) Adds a set of EntityRelation definitions for multiple legal Entity Relations.
void	addLegalEntityRelationDefinitions(List<AttributeValueTable> implEntRelsList) Adds new legal EntityRelation definitions for a table list of legal Entity Relations.
void	addRegexMappingDefinition(AttributeValueTable avt) Adds a new InformationExtractionRegexMappingDefinition for a Regex Mapping specified in a table.
void	addRegexMappingDefinition(InformationExtractionRegexMappingDefinition def) Adds a new RegexMapping definition for an RegexMapping.
void	addRegexMappingDefinitions(InformationExtractionRegexMappingDefinition[] defs) Adds a set of RegexMapping definitions for multiple RegexMappings.
void	addRegexMappingDefinitions(List<AttributeValueTable> regexMappingsList) Adds new InformationExtractionRegexMappingDefinitions for a table list of Regex Mappings.
void	addRegexPatternDefinition(AttributeValueTable avt) Adds a new InformationExtractionRegexPatternDefinition for a Regex NER Pattern specified in a table.
void	addRegexPatternDefinition(InformationExtractionRegexPatternDefinition def) Adds a new RegexPattern definition for an RegexPattern.
void	addRegexPatternDefinitions(InformationExtractionRegexPatternDefinition[] defs) Adds a set of RegexPattern definitions for multiple RegexPatterns.
void	addRegexPatternDefinitions(List<AttributeValueTable> regexNerPattsList) Adds new InformationExtractionRegexPatternDefinitions for a table list of Regex NER Patterns.
void	addRegexRuleDefinition(AttributeValueTable avt) Adds a new InformationExtractionRegexRuleDefinition for a Tokens Regex rule specified in a table.
void	addRegexRuleDefinition(InformationExtractionRegexRuleDefinition def) Adds a new RegexRule definition for an RegexRule.
void	addRegexRuleDefinitions(InformationExtractionRegexRuleDefinition[] defs) Adds a set of RegexRule definitions for multiple RegexRules.
void	addRegexRuleDefinitions(List<AttributeValueTable> regexRulesList) Adds new InformationExtractionRegexRuleDefinitions for a table list of Tokens Regex rules.
void	applySettings(AttributeValueTable avt) Applies settings from the specified table.
InformationExtractionEntityPhraseDefinition[]	getEntityPhraseDefinitions() Gets all the EntityPhrase definitions for this instance.
InformationExtractionEntityRelationTypeDefinition[]	getEntityRelationTypeDefinitions() Gets all the EntityRelationType definitions for this instance.
InformationExtractionEntityTypeDefinition[]	getEntityTypeDefinitions() Gets all the EntityType definitions for this instance.
InformationExtractionImplicitEntityRelationDefinition[]	getImplicitEntityRelationDefinitions() Gets all the ImplicitEntityRelation definitions for this instance.
InformationExtractionLegalEntityRelationDefinition[]	getLegalEntityRelationDefinitions() Gets all the legal EntityRelation definitions for this instance.
InformationExtractionRegexMappingDefinition[]	getRegexMappingDefinitions() Gets all the RegexMapping definitions for this instance.
InformationExtractionRegexPatternDefinition[]	getRegexPatternDefinitions() Gets all the RegexPattern definitions for this instance.
InformationExtractionRegexRuleDefinition[]	getRegexRuleDefinitions() Gets all the RegexRule definitions for this instance.
void	removeEntityPhraseDefinitions() Removes all EntityPhrase definitions from this instance.
void	removeEntityRelationTypeDefinitions() Removes all EntityRelationType definitions from this instance.
void	removeEntityTypeDefinitions() Removes all EntityType definitions from this instance.
void	removeImplicitEntityRelationDefinitions() Removes all ImplicitEntityRelation definitions from this instance.
void	removeLegalEntityRelationDefinitions() Removes all legal EntityRelation definitions from this definition.
void	removeRegexMappingDefinitions() Removes all RegexMapping definitions from this instance.
void	removeRegexPatternDefinitions() Removes all RegexPattern definitions from this instance.
void	removeRegexRuleDefinitions() Removes all RegexRule definitions from this instance.
void	setEntityPhraseDefinitions(InformationExtractionEntityPhraseDefinition[] defs) Replaces the set of new EntityPhrase definitions for multiple EntityPhrases.
void	setEntityRelationTypeDefinitions(InformationExtractionEntityRelationTypeDefinition[] defs) Replaces the set of new EntityRelationType definitions for multiple EntityRelationTypes.
void	setEntityTypeDefinitions(InformationExtractionEntityTypeDefinition[] defs) Replaces the set of new EntityType definitions for multiple EntityTypes.
void	setImplicitEntityRelationDefinitions(InformationExtractionImplicitEntityRelationDefinition[] defs) Replaces the set of new ImplicitEntityRelation definitions for multiple ImplicitEntityRelations.
void	setLegalEntityRelationDefinitions(InformationExtractionLegalEntityRelationDefinition[] defs) Replaces the set of new definitions for multiple LegalEntityRelations.
void	setRegexMappingDefinitions(InformationExtractionRegexMappingDefinition[] defs) Replaces the set of new RegexMapping definitions for multiple RegexMappings.
void	setRegexPatternDefinitions(InformationExtractionRegexPatternDefinition[] defs) Replaces the set of new RegexPattern definitions for multiple RegexPatterns.
void	setRegexRuleDefinitions(InformationExtractionRegexRuleDefinition[] defs) Replaces the set of new RegexRule definitions for multiple RegexRules.
static InformationExtractionDomainSpecificationDefinition	toInformationExtractionDomainSpecificationDefinition(LibraryObjectDefinition lodef) Casts specified LibraryObjectDefinition to a InformationExtractionDomainSpecificationDefinition.
static InformationExtractionDomainSpecificationDefinition	toInformationExtractionDomainSpecificationDefinition(LibraryObjectDefinition lodef, boolean enforceCompat) Casts specified LibraryObjectDefinition to a InformationExtractionDomainSpecificationDefinition.

Methods inherited from class oracle.ifs.core.extraction.beans.InformationExtractionAbstractSpecificationDefinition

toInformationExtractionAbstractSpecificationDefinition, toInformationExtractionAbstractSpecificationDefinition

Methods inherited from class oracle.ifs.beans.SystemObjectDefinition

addCategoryDefinition, addCategoryDefinitionForUpdate, addCategoryDefinitions, addCategoryForDelete, getCategoriesForDelete, getCategoryDefinitions, getCategoryDefinitionsForUpdate, getCreateCategoriesServerSideOption, removeCategoriesForDelete, removeCategoryDefinitions, removeCategoryDefinitionsForUpdate, setCategoryDefinitions, setCreateCategoriesServerSideOption, toSystemObjectDefinition, toSystemObjectDefinition

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

InformationExtractionDomainSpecificationDefinition

public InformationExtractionDomainSpecificationDefinition(LibrarySessionInterface session)
                                                   throws IfsException

Constructs a definition explicitly capturing the session.

The initial ClassObject will be InformationExtractionDomainSpecification.

Parameters:

session - the current session

Throws:

IfsException - if the operation fails

(Published)

InformationExtractionDomainSpecificationDefinition

public InformationExtractionDomainSpecificationDefinition(LibrarySessionInterface session,
                                                          String className)
                                                   throws IfsException

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

Parameters:

session - the current session

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 InformationExtractionAbstractSpecificationDefinition

Parameters:

avt - the table having the definition settings

Throws:

IfsException - if the operation fails

(Published)

addEntityTypeDefinition

public void addEntityTypeDefinition(InformationExtractionEntityTypeDefinition def)
                             throws IfsException

Adds a new EntityType definition for an EntityType.

Parameters:

def - the definition for the EntityType

Throws:

IfsException - if the operation fails

(Published)

addEntityTypeDefinition

public void addEntityTypeDefinition(AttributeValueTable avt)
                             throws IfsException

Adds a new InformationExtractionEntityTypeDefinition for a EntityType specified in a table.

Parameters:

avt - the EntityType table

Throws:

IfsException - if the operation fails

(Published)

addEntityTypeDefinitions

public void addEntityTypeDefinitions(List<AttributeValueTable> entTypesList)
                              throws IfsException

Adds new InformationExtractionEntityTypeDefinitions for a table list of EntityTypes.

Parameters:

entTypesList - the table list of EntityTypes

Throws:

IfsException - if the operation fails

(Published)

addEntityTypeDefinitions

public void addEntityTypeDefinitions(InformationExtractionEntityTypeDefinition[] defs)
                              throws IfsException

Adds a set of EntityType definitions for multiple EntityTypes.

Parameters:

defs - the definitions for the EntityTypes

Throws:

IfsException - if the operation fails

(Published)

setEntityTypeDefinitions

public void setEntityTypeDefinitions(InformationExtractionEntityTypeDefinition[] defs)
                              throws IfsException

Replaces the set of new EntityType definitions for multiple EntityTypes.

Parameters:

defs - the definitions for the EntityTypes

Throws:

IfsException - if the operation fails

(Published)

removeEntityTypeDefinitions

public void removeEntityTypeDefinitions()
                                 throws IfsException

Removes all EntityType definitions from this instance.

Throws:

IfsException - if the operation fails

(Published)

getEntityTypeDefinitions

public InformationExtractionEntityTypeDefinition[] getEntityTypeDefinitions()
                                                                     throws IfsException

Gets all the EntityType definitions for this instance.

Returns:

the definitions for the EntityTypes

Throws:

IfsException - if the operation fails

(Published)

addEntityRelationTypeDefinition

public void addEntityRelationTypeDefinition(InformationExtractionEntityRelationTypeDefinition def)
                                     throws IfsException

Adds a new EntityRelationType definition for an EntityRelationType.

Parameters:

def - the definition for the EntityRelationType

Throws:

IfsException - if the operation fails

(Published)

addEntityRelationTypeDefinition

public void addEntityRelationTypeDefinition(AttributeValueTable avt)
                                     throws IfsException

Adds a new InformationExtractionEntityTypeDefinition for a EntityRelationType specified in a table.

Parameters:

avt - the EntityRelationType table

Throws:

IfsException - if the operation fails

(Published)

addEntityRelationTypeDefinitions

public void addEntityRelationTypeDefinitions(List<AttributeValueTable> entRelTypesList)
                                      throws IfsException

Adds new InformationExtractionEntityRelationTypeDefinitions for a table list of EntityRelationTypes.

Parameters:

entRelTypesList - the table list of EntityRelationTypes

Throws:

IfsException - if the operation fails

(Published)

addEntityRelationTypeDefinitions

public void addEntityRelationTypeDefinitions(InformationExtractionEntityRelationTypeDefinition[] defs)
                                      throws IfsException

Adds a set of EntityRelationType definitions for multiple EntityRelationTypes.

Parameters:

defs - the definitions for the EntityRelationTypes

Throws:

IfsException - if the operation fails

(Published)

setEntityRelationTypeDefinitions

public void setEntityRelationTypeDefinitions(InformationExtractionEntityRelationTypeDefinition[] defs)
                                      throws IfsException

Replaces the set of new EntityRelationType definitions for multiple EntityRelationTypes.

Parameters:

defs - the definitions for the EntityRelationTypes

Throws:

IfsException - if the operation fails

(Published)

removeEntityRelationTypeDefinitions

public void removeEntityRelationTypeDefinitions()
                                         throws IfsException

Removes all EntityRelationType definitions from this instance.

Throws:

IfsException - if the operation fails

(Published)

getEntityRelationTypeDefinitions

public InformationExtractionEntityRelationTypeDefinition[] getEntityRelationTypeDefinitions()
                                                                                     throws IfsException

Gets all the EntityRelationType definitions for this instance.

Returns:

the definitions for the EntityRelationTypes

Throws:

IfsException - if the operation fails

(Published)

addLegalEntityRelationDefinition

public void addLegalEntityRelationDefinition(InformationExtractionLegalEntityRelationDefinition def)
                                      throws IfsException

Adds a new legal EntityRelation definition for an InformationExtractionLegalEntityRelation.

Parameters:

def - the definition for the LegalEntityRelation

Throws:

IfsException - if the operation fails

(Published)

addLegalEntityRelationDefinition

public void addLegalEntityRelationDefinition(AttributeValueTable avt)
                                      throws IfsException

Adds a new definition for a Legal Entity Relation specified in a table.

Parameters:

def - the legal Entity Relation table

Throws:

IfsException - if the operation fails

(Published)

addLegalEntityRelationDefinitions

public void addLegalEntityRelationDefinitions(List<AttributeValueTable> implEntRelsList)
                                       throws IfsException

Adds new legal EntityRelation definitions for a table list of legal Entity Relations.

Parameters:

implEntRelsList - the table list of legal Entity Relations

Throws:

IfsException - if the operation fails

(Published)

addLegalEntityRelationDefinitions

public void addLegalEntityRelationDefinitions(InformationExtractionLegalEntityRelationDefinition[] defs)
                                       throws IfsException

Adds a set of EntityRelation definitions for multiple legal Entity Relations.

Parameters:

defs - the definitions for the LegalEntityRelations

Throws:

IfsException - if the operation fails

(Published)

setLegalEntityRelationDefinitions

public void setLegalEntityRelationDefinitions(InformationExtractionLegalEntityRelationDefinition[] defs)
                                       throws IfsException

Replaces the set of new definitions for multiple LegalEntityRelations.

Parameters:

defs - the definitions for the LegalEntityRelations

Throws:

IfsException - if the operation fails

(Published)

removeLegalEntityRelationDefinitions

public void removeLegalEntityRelationDefinitions()
                                          throws IfsException

Removes all legal EntityRelation definitions from this definition.

Throws:

IfsException - if the operation fails

(Published)

getLegalEntityRelationDefinitions

public InformationExtractionLegalEntityRelationDefinition[] getLegalEntityRelationDefinitions()
                                                                                       throws IfsException

Gets all the legal EntityRelation definitions for this instance.

Returns:

the definitions for the LegalEntityRelations

Throws:

IfsException - if the operation fails

(Published)

addImplicitEntityRelationDefinition

public void addImplicitEntityRelationDefinition(InformationExtractionImplicitEntityRelationDefinition def)
                                         throws IfsException

Adds a new ImplicitEntityRelation definition for an ImplicitEntityRelation.

Parameters:

def - the definition for the ImplicitEntityRelation

Throws:

IfsException - if the operation fails

(Published)

addImplicitEntityRelationDefinition

public void addImplicitEntityRelationDefinition(AttributeValueTable avt)
                                         throws IfsException

Adds a new InformationExtractionImplicitEntityRelationDefinition for a Implicit Entity Relation specified in a table.

Parameters:

def - the Implicit Entity Relation table

Throws:

IfsException - if the operation fails

(Published)

addImplicitEntityRelationDefinitions

public void addImplicitEntityRelationDefinitions(List<AttributeValueTable> implEntRelsList)
                                          throws IfsException

Adds new InformationExtractionImplicitEntityRelationDefinitions for a table list of Implicit Entity Relations.

Parameters:

implEntRelsList - the table list of Implicit Entity Relations

Throws:

IfsException - if the operation fails

(Published)

addImplicitEntityRelationDefinitions

public void addImplicitEntityRelationDefinitions(InformationExtractionImplicitEntityRelationDefinition[] defs)
                                          throws IfsException

Adds a set of ImplicitEntityRelation definitions for multiple ImplicitEntityRelations.

Parameters:

defs - the definitions for the ImplicitEntityRelations

Throws:

IfsException - if the operation fails

(Published)

setImplicitEntityRelationDefinitions

public void setImplicitEntityRelationDefinitions(InformationExtractionImplicitEntityRelationDefinition[] defs)
                                          throws IfsException

Replaces the set of new ImplicitEntityRelation definitions for multiple ImplicitEntityRelations.

Parameters:

defs - the definitions for the ImplicitEntityRelations

Throws:

IfsException - if the operation fails

(Published)

removeImplicitEntityRelationDefinitions

public void removeImplicitEntityRelationDefinitions()
                                             throws IfsException

Removes all ImplicitEntityRelation definitions from this instance.

Throws:

IfsException - if the operation fails

(Published)

getImplicitEntityRelationDefinitions

public InformationExtractionImplicitEntityRelationDefinition[] getImplicitEntityRelationDefinitions()
                                                                                             throws IfsException

Gets all the ImplicitEntityRelation definitions for this instance.

Returns:

the definitions for the ImplicitEntityRelations

Throws:

IfsException - if the operation fails

(Published)

addEntityPhraseDefinition

public void addEntityPhraseDefinition(InformationExtractionEntityPhraseDefinition def)
                               throws IfsException

Adds a new EntityPhrase definition for an EntityPhrase.

Parameters:

def - the definition for the EntityPhrase

Throws:

IfsException - if the operation fails

(Published)

addEntityPhraseDefinition

public void addEntityPhraseDefinition(AttributeValueTable avt)
                               throws IfsException

Adds a new InformationExtractionEntityPhraseDefinition for an InformationExtractionEntityPhrase specified in a table.

Parameters:

def - the Entity phrase table

Throws:

IfsException - if the operation fails

(Published)

addEntityPhraseDefinitions

public void addEntityPhraseDefinitions(List<AttributeValueTable> entPhrasesList)
                                throws IfsException

Adds new InformationExtractionEntityPhraseDefinitions for a table list of InformationExtractionEntityPhrases.

Parameters:

entPhrasesList - the table list of InformationExtractionEntityPhrases

Throws:

IfsException - if the operation fails

(Published)

addEntityPhraseDefinitions

public void addEntityPhraseDefinitions(InformationExtractionEntityPhraseDefinition[] defs)
                                throws IfsException

Adds a set of EntityPhrase definitions for multiple EntityPhrases.

Parameters:

defs - the definitions for the EntityPhrases

Throws:

IfsException - if the operation fails

(Published)

setEntityPhraseDefinitions

public void setEntityPhraseDefinitions(InformationExtractionEntityPhraseDefinition[] defs)
                                throws IfsException

Replaces the set of new EntityPhrase definitions for multiple EntityPhrases.

Parameters:

defs - the definitions for the EntityPhrases

Throws:

IfsException - if the operation fails

(Published)

removeEntityPhraseDefinitions

public void removeEntityPhraseDefinitions()
                                   throws IfsException

Removes all EntityPhrase definitions from this instance.

Throws:

IfsException - if the operation fails

(Published)

getEntityPhraseDefinitions

public InformationExtractionEntityPhraseDefinition[] getEntityPhraseDefinitions()
                                                                         throws IfsException

Gets all the EntityPhrase definitions for this instance.

Returns:

the definitions for the EntityPhrases

Throws:

IfsException - if the operation fails

(Published)

addRegexPatternDefinition

public void addRegexPatternDefinition(InformationExtractionRegexPatternDefinition def)
                               throws IfsException

Adds a new RegexPattern definition for an RegexPattern.

Parameters:

def - the definition for the RegexPattern

Throws:

IfsException - if the operation fails

(Published)

addRegexPatternDefinition

public void addRegexPatternDefinition(AttributeValueTable avt)
                               throws IfsException

Adds a new InformationExtractionRegexPatternDefinition for a Regex NER Pattern specified in a table.

Parameters:

def - the Regex NER Pattern table

Throws:

IfsException - if the operation fails

(Published)

addRegexPatternDefinitions

public void addRegexPatternDefinitions(List<AttributeValueTable> regexNerPattsList)
                                throws IfsException

Adds new InformationExtractionRegexPatternDefinitions for a table list of Regex NER Patterns.

Parameters:

regexNerPattsList - the table list of Regex NER Patterns

Throws:

IfsException - if the operation fails

(Published)

addRegexPatternDefinitions

public void addRegexPatternDefinitions(InformationExtractionRegexPatternDefinition[] defs)
                                throws IfsException

Adds a set of RegexPattern definitions for multiple RegexPatterns.

Parameters:

defs - the definitions for the RegexPatterns

Throws:

IfsException - if the operation fails

(Published)

setRegexPatternDefinitions

public void setRegexPatternDefinitions(InformationExtractionRegexPatternDefinition[] defs)
                                throws IfsException

Replaces the set of new RegexPattern definitions for multiple RegexPatterns.

Parameters:

defs - the definitions for the RegexPatterns

Throws:

IfsException - if the operation fails

(Published)

removeRegexPatternDefinitions

public void removeRegexPatternDefinitions()
                                   throws IfsException

Removes all RegexPattern definitions from this instance.

Throws:

IfsException - if the operation fails

(Published)

getRegexPatternDefinitions

public InformationExtractionRegexPatternDefinition[] getRegexPatternDefinitions()
                                                                         throws IfsException

Gets all the RegexPattern definitions for this instance.

Returns:

the definitions for the RegexPatterns

Throws:

IfsException - if the operation fails

(Published)

addRegexRuleDefinition

public void addRegexRuleDefinition(InformationExtractionRegexRuleDefinition def)
                            throws IfsException

Adds a new RegexRule definition for an RegexRule.

Parameters:

def - the definition for the RegexRule

Throws:

IfsException - if the operation fails

(Published)

addRegexRuleDefinition

public void addRegexRuleDefinition(AttributeValueTable avt)
                            throws IfsException

Adds a new InformationExtractionRegexRuleDefinition for a Tokens Regex rule specified in a table.

Parameters:

def - the Tokens Regex rule table

Throws:

IfsException - if the operation fails

(Published)

addRegexRuleDefinitions

public void addRegexRuleDefinitions(List<AttributeValueTable> regexRulesList)
                             throws IfsException

Adds new InformationExtractionRegexRuleDefinitions for a table list of Tokens Regex rules.

Parameters:

regexRulesList - the table list of Tokens Regex rules

Throws:

IfsException - if the operation fails

(Published)

addRegexRuleDefinitions

public void addRegexRuleDefinitions(InformationExtractionRegexRuleDefinition[] defs)
                             throws IfsException

Adds a set of RegexRule definitions for multiple RegexRules.

Parameters:

defs - the definitions for the RegexRules

Throws:

IfsException - if the operation fails

(Published)

setRegexRuleDefinitions

public void setRegexRuleDefinitions(InformationExtractionRegexRuleDefinition[] defs)
                             throws IfsException

Replaces the set of new RegexRule definitions for multiple RegexRules.

Parameters:

defs - the definitions for the RegexRules

Throws:

IfsException - if the operation fails

(Published)

removeRegexRuleDefinitions

public void removeRegexRuleDefinitions()
                                throws IfsException

Removes all RegexRule definitions from this instance.

Throws:

IfsException - if the operation fails

(Published)

getRegexRuleDefinitions

public InformationExtractionRegexRuleDefinition[] getRegexRuleDefinitions()
                                                                   throws IfsException

Gets all the RegexRule definitions for this instance.

Returns:

the definitions for the RegexRules

Throws:

IfsException - if the operation fails

(Published)

addRegexMappingDefinition

public void addRegexMappingDefinition(InformationExtractionRegexMappingDefinition def)
                               throws IfsException

Adds a new RegexMapping definition for an RegexMapping.

Parameters:

def - the definition for the RegexMapping

Throws:

IfsException - if the operation fails

(Published)

addRegexMappingDefinition

public void addRegexMappingDefinition(AttributeValueTable avt)
                               throws IfsException

Adds a new InformationExtractionRegexMappingDefinition for a Regex Mapping specified in a table.

Parameters:

def - the Regex Mapping table

Throws:

IfsException - if the operation fails

(Published)

addRegexMappingDefinitions

public void addRegexMappingDefinitions(List<AttributeValueTable> regexMappingsList)
                                throws IfsException

Adds new InformationExtractionRegexMappingDefinitions for a table list of Regex Mappings.

Parameters:

regexMappingsList - the table list of Regex Mappings

Throws:

IfsException - if the operation fails

(Published)

addRegexMappingDefinitions

public void addRegexMappingDefinitions(InformationExtractionRegexMappingDefinition[] defs)
                                throws IfsException

Adds a set of RegexMapping definitions for multiple RegexMappings.

Parameters:

defs - the definitions for the RegexMappings

Throws:

IfsException - if the operation fails

(Published)

setRegexMappingDefinitions

public void setRegexMappingDefinitions(InformationExtractionRegexMappingDefinition[] defs)
                                throws IfsException

Replaces the set of new RegexMapping definitions for multiple RegexMappings.

Parameters:

defs - the definitions for the RegexMappings

Throws:

IfsException - if the operation fails

(Published)

removeRegexMappingDefinitions

public void removeRegexMappingDefinitions()
                                   throws IfsException

Removes all RegexMapping definitions from this instance.

Throws:

IfsException - if the operation fails

(Published)

getRegexMappingDefinitions

public InformationExtractionRegexMappingDefinition[] getRegexMappingDefinitions()
                                                                         throws IfsException

Gets all the RegexMapping definitions for this instance.

Returns:

the definitions for the RegexMappings

Throws:

IfsException - if the operation fails

(Published)

toInformationExtractionDomainSpecificationDefinition

public static InformationExtractionDomainSpecificationDefinition toInformationExtractionDomainSpecificationDefinition(LibraryObjectDefinition lodef)
                                                                                                               throws IfsException

Casts specified LibraryObjectDefinition to a InformationExtractionDomainSpecificationDefinition.

Return null if the specified definition is not a InformationExtractionDomainSpecificationDefinition, or if the specified definition is null.

Parameters:

lodef - the definition to be casted

Returns:

a InformationExtractionDomainSpecificationDefinition casted from the specified definition

Throws:

IfsException - is not currently thrown

toInformationExtractionDomainSpecificationDefinition

public static InformationExtractionDomainSpecificationDefinition toInformationExtractionDomainSpecificationDefinition(LibraryObjectDefinition lodef,
                                                                                                                      boolean enforceCompat)
                                                                                                               throws IfsException

Casts specified LibraryObjectDefinition to a InformationExtractionDomainSpecificationDefinition.

Return null if the specified definition is null. If non-null and unable to cast, return null if enforceCompat is false but throw an IfsException if the specified definition is not a InformationExtractionDomainSpecificationDefinition.

Parameters:

lodef - the definition to be casted

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

Returns:

a InformationExtractionDomainSpecificationDefinition casted from the specified definition

Throws:

IfsException - 10822: if operation fails