oracle.ifs.core.extraction.beans

Class InformationExtractionRegexRule

java.lang.Object

oracle.ifs.beans.LibraryObject

oracle.ifs.beans.TieLibraryObject

oracle.ifs.beans.SimpleObject

oracle.ifs.beans.TieSimpleObject

oracle.ifs.core.extraction.beans.InformationExtractionRegexRule

All Implemented Interfaces:

Comparable, IfsEventHandler, LibraryObjectInterface, LooselyBoundedCacheable, SimpleObjectInterface, Traceable

Direct Known Subclasses:

TieInformationExtractionRegexRule

public class InformationExtractionRegexRule
extends TieSimpleObject

A InformationExtractionRegexRule is Internal Information Extraction TokensRegex Extraction Rule.

Author:

Dave Long

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTION_ATTRIBUTE The name of the Attribute representing The action to take.
static String	CLASS_NAME The name of the ClassObject representing this class.
static String	DOMAINSPECIFICATION_ATTRIBUTE The name of the Attribute representing The InformationExtractionDomainSpecification for which this object is defined.
static String	NAME_ATTRIBUTE The name of the Attribute representing the name used to identify a TokensRegex extraction rule.
static String	PATTERN_ATTRIBUTE The name of the Attribute representing the TokensRegex pattern.
static String	RESULT_ATTRIBUTE The name of the Attribute representing The rule's result.
static String	RULETYPE_ATTRIBUTE The name of the Attribute representing the rule type (entityruler, tokenmatcher, text, tokens, composite or filter).
static String	RULETYPE_COMPOSITE The String that identifies a RuleType for CoreNlpRegexRule for "composite".
static String	RULETYPE_DEPENDENCYMATCHER The String that identifies a RuleType for DependencyMatcherRegexRule.
static String	RULETYPE_ENTITYRULER The String that identifies a RuleType for EntityRulerRegexRule.
static String	RULETYPE_FILTER The String that identifies a RuleType for CoreNlpRegexRule for "filter".
static String	RULETYPE_TEXT The String that identifies a RuleType for CoreNlpRegexRule for "text".
static String	RULETYPE_TOKENMATCHER The String that identifies a RuleType for TokenMatcherRegexRule.
static String	RULETYPE_TOKENS The String that identifies a RuleType for CoreNlpRegexRule for "tokens".
static String	UUID_ATTRIBUTE The name of the Attribute representing the UUID.

Fields inherited from class oracle.ifs.beans.LibraryObject

DOMAIN_UNIQUENAME_DEFAULT_DELIMITER, m_ClassId, m_Id, m_Session, PROPERTYBUNDLE_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
InformationExtractionRegexRule(LibrarySession session, Long id, Long classId, S_LibraryObjectData data) Construct a InformationExtractionRegexRule object.

Method Summary

Modifier and Type	Method and Description
String	getAction() Gets the action to take.
InformationExtractionDomainSpecification	getDomainSpecification() Gets The InformationExtractionDomainSpecification for which this object is defined.
String	getPattern() Gets the TokensRegex pattern.
String	getResult() Gets the rule result.
String	getRuleType() Gets the rule type (text, tokens, composite or filter).
String	getUuid() Gets the value of the UUID attribute.
boolean	hasNameAttribute() Returns true if this object is an instance of a class that has a NAME attribute, and false otherwise.

Methods inherited from class oracle.ifs.beans.SimpleObject

free, handleCreate, isValidEventType

Methods inherited from class oracle.ifs.beans.LibraryObject

added, addSimpleProperty, addSimpleProperty, applyProperties, auditCreated, auditUpdated, canPurge, checkIfPropertyBundleSupported, checkRequiredAttributeSet, clearCopyContext, clearFreeContext, clearUpdateContext, compareTo, constructIdArray, constructIdArray, constructLibraryObject, constructLibraryObjectVector, createDedicatedPropertyBundle, createInstance, deriveDomainUniqueName, dispose, equals, equals, free, freeAll, get, getAttribute, getAttributeByUpperCaseName, getAttributes, getAttributesByUpperCaseNames, getAuditDomainContext, getAuditEventFolderContext, getClassId, getClassname, getClassName, getClassObject, getCommonName, getCommonNameAndClass, getCopyContext, getCreateContext, getData, getDefinition, getDefinitionForSimplePropertyUpdates, getEffectivePolicyListElements, getEventualAttributeByUpperCaseName, getFreeContext, getId, getLabel, getName, getObjectReferenceAttribute, getOperationActionSpecificationContext, getPropertyBundle, getPropertyValue, getPublicObjectAttribute, getResourceString, getResourceString, getSchemaObjectAttribute, getSession, getSessionInterface, getSharedStateFactory, getSimpleObjectAttribute, getSimpleProperties, getSimpleProperty, getSimplePropertyValue, getStringIdentifier, getSystemObjectAttribute, getTraceLogger, getUpdateContext, handleAdminModeChange, handleEvent, handleFree, handleUpdate, hashCode, hasPropertyBundleAttribute, invalidateState, invokeOperation, invokeOperation, invokeServerMethod, isConnected, isCoreEventPostingEnabled, isInstanceOf, isPersistent, isTraced, lockRows, lookupInstanceLabel, performPostCreateExtensions, performPostFreeExtensions, performPostUpdateExtensions, performPreCreateExtensions, performPreFreeExtensions, performPreUpdateExtensions, postCreate, postEvent, postEvent, postFree, postUpdate, preCreate, preFree, prePostAuditEvent, preUpdate, putProperty, putProperty, removeAllProperties, removeAllSimpleProperties, removeAllSimpleProperties, removed, removeProperty, removeSimpleProperty, removeSimpleProperty, renderAsRandomAccessContent, renderAsReader, renderAsStream, setAttribute, setAttribute, setAttributes, setAttributes, setCopyContext, setFreeContext, setId, setName, setPropertyBundle, setPropertyValue, setUpdateContext, toString, trace, trustHandleCreate, trustHandleCreateAsAdmin, trustHandleFree, trustHandleFreeAsAdmin, trustHandleUpdate, trustHandleUpdateAsAdmin, update, updateAndExposeDefinition, validatePropertyValues, vectorLibraryObjectElement, vectorToLibraryObjectArray, verifyAdministrationMode, verifyConnected, verifyPersistent, verifySystemUserAccess, verifyTargetObject

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.ifs.common.LibraryObjectInterface

getAttributeByUpperCaseName, getClassId, getId, getSessionInterface

Methods inherited from interface oracle.ifs.common.Traceable

getTraceLogger, isTraced, trace

Field Detail

CLASS_NAME

public static final String CLASS_NAME

The name of the ClassObject representing this class.

See Also:

Constant Field Values

UUID_ATTRIBUTE

public static final String UUID_ATTRIBUTE

The name of the Attribute representing the UUID.

See Also:

Constant Field Values

DOMAINSPECIFICATION_ATTRIBUTE

public static final String DOMAINSPECIFICATION_ATTRIBUTE

The name of the Attribute representing The InformationExtractionDomainSpecification for which this object is defined.

See Also:

Constant Field Values

NAME_ATTRIBUTE

public static final String NAME_ATTRIBUTE

The name of the Attribute representing the name used to identify a TokensRegex extraction rule.

See Also:

Constant Field Values

RULETYPE_ATTRIBUTE

public static final String RULETYPE_ATTRIBUTE

The name of the Attribute representing the rule type (entityruler, tokenmatcher, text, tokens, composite or filter).

See Also:

Constant Field Values

PATTERN_ATTRIBUTE

public static final String PATTERN_ATTRIBUTE

The name of the Attribute representing the TokensRegex pattern.

See Also:

Constant Field Values

ACTION_ATTRIBUTE

public static final String ACTION_ATTRIBUTE

The name of the Attribute representing The action to take.

See Also:

Constant Field Values

RESULT_ATTRIBUTE

public static final String RESULT_ATTRIBUTE

The name of the Attribute representing The rule's result.

See Also:

Constant Field Values

RULETYPE_TOKENS

public static final String RULETYPE_TOKENS

The String that identifies a RuleType for CoreNlpRegexRule for "tokens".

See Also:

Constant Field Values

RULETYPE_TEXT

public static final String RULETYPE_TEXT

The String that identifies a RuleType for CoreNlpRegexRule for "text".

See Also:

Constant Field Values

RULETYPE_COMPOSITE

public static final String RULETYPE_COMPOSITE

The String that identifies a RuleType for CoreNlpRegexRule for "composite".

See Also:

Constant Field Values

RULETYPE_FILTER

public static final String RULETYPE_FILTER

The String that identifies a RuleType for CoreNlpRegexRule for "filter".

See Also:

Constant Field Values

RULETYPE_ENTITYRULER

public static final String RULETYPE_ENTITYRULER

The String that identifies a RuleType for EntityRulerRegexRule.

See Also:

Constant Field Values

RULETYPE_TOKENMATCHER

public static final String RULETYPE_TOKENMATCHER

The String that identifies a RuleType for TokenMatcherRegexRule.

See Also:

Constant Field Values

RULETYPE_DEPENDENCYMATCHER

public static final String RULETYPE_DEPENDENCYMATCHER

The String that identifies a RuleType for DependencyMatcherRegexRule.

See Also:

Constant Field Values

Constructor Detail

InformationExtractionRegexRule

public InformationExtractionRegexRule(LibrarySession session,
                                      Long id,
                                      Long classId,
                                      S_LibraryObjectData data)
                               throws IfsException

Construct a InformationExtractionRegexRule object.

Parameters:

session - current LibrarySession

id - object id

classId - class id

data - data component

Throws:

IfsException - if the operation fails

Method Detail

hasNameAttribute

public boolean hasNameAttribute()
                         throws IfsException

Description copied from class: LibraryObject

Returns true if this object is an instance of a class that has a NAME attribute, and false otherwise.

Overrides:

hasNameAttribute in class LibraryObject

Returns:

true if the object has a NAME attribute.

Throws:

IfsException - if operation fails.

getUuid

public String getUuid()
               throws IfsException

Gets the value of the UUID attribute.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getDomainSpecification

public InformationExtractionDomainSpecification getDomainSpecification()
                                                                throws IfsException

Gets The InformationExtractionDomainSpecification for which this object is defined.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getRuleType

public String getRuleType()
                   throws IfsException

Gets the rule type (text, tokens, composite or filter).

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getPattern

public String getPattern()
                  throws IfsException

Gets the TokensRegex pattern.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getAction

public String getAction()
                 throws IfsException

Gets the action to take.

Returns:

the rule's action

Throws:

IfsException - if the operation fails

getResult

public String getResult()
                 throws IfsException

Gets the rule result.

Returns:

the rule's result.

Throws:

IfsException - if the operation fails