oracle.ifs.core.extraction.beans

Class InformationExtractionOutcomeMarking

java.lang.Object

oracle.ifs.beans.LibraryObject

oracle.ifs.beans.TieLibraryObject

oracle.ifs.beans.SimpleObject

oracle.ifs.beans.TieSimpleObject

oracle.ifs.core.extraction.beans.InformationExtractionOutcomeMarking

All Implemented Interfaces:

Comparable, IfsEventHandler, LibraryObjectInterface, LooselyBoundedCacheable, SimpleObjectInterface, Traceable

Direct Known Subclasses:

TieInformationExtractionOutcomeMarking

public class InformationExtractionOutcomeMarking
extends TieSimpleObject

A InformationExtractionOutcomeMarking is an internal Information Extraction outcome marking.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InformationExtractionOutcomeMarking.MarkingStatus Enumeration for the various marking statuses.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLASS_NAME The name of the ClassObject representing this class.
static String	CONFIDENCE_ATTRIBUTE The name of the Attribute representing The confidence level that this marking is correct (0.0 - 1.0).
static String	ENTITYTYPE_ATTRIBUTE The name of the Attribute representing The entity type of the marking.
static String	INFORMATIONEXTRACTION_ATTRIBUTE The name of the Attribute representing The Information Extraction in which this marking was defined.
static String	MARKINGDETAILS_ATTRIBUTE The name of the Attribute representing the details pertaining to the marking.
static int	MARKINGSTATUS_UNCONFIRMED The status value indicating the marking is unconfirmed.
static int	STATUS_ACCEPTED The status value indicating the marking has been confirmed.
static String	STATUS_ATTRIBUTE The name of the Attribute representing The status of the marking (enumerated).
static int	STATUS_CONFIRMED The status value indicating the marking has been confirmed.
static int	STATUS_REJECTED The status value indicating the marking has been reviewed and rejected.
static int	STATUS_REVIEWING The status value indicating the marking is being reviewed.
static int	STATUS_UNKNOWN The status value indicating the marking status is unknown.
static int	STATUS_UNREVIEWED The status value indicating the marking is unconfirmed.
static String	TOKENLIST_ATTRIBUTE The name of the Attribute representing The token list comprising the set of tokens for the marking.

Fields inherited from class oracle.ifs.beans.LibraryObject

DOMAIN_UNIQUENAME_DEFAULT_DELIMITER, m_ClassId, m_Id, m_Session, NAME_ATTRIBUTE, PROPERTYBUNDLE_ATTRIBUTE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addMarkingDetail(String key, AttributeValue value) Adds an marking detail (SimpleProperty) for this object.
double	getConfidence() Gets the confidence level that this marking is correct (0.0 - 1.0).
InformationExtractionEntityType	getEntityType() Gets entity type of the marking.
int	getFirstTokenPosition() Gets the token position of the first token in this marking's TokenList.
InformationExtraction	getInformationExtraction() Gets the InformationExtraction in which this marking was defined.
AttributeValue	getMarkingDetail(String propName) Gets the marking detail matching the specified property name.
SimpleProperty[]	getMarkingDetails() Gets the details pertaining to the marking.
String	getMarkingText() Gets text from the parsed text corresponding to this marking.
int	getSentenceNumber() Gets the sentence number (zero based) in which the first token in the marking appears.
InformationExtractionOutcomeMarking.MarkingStatus	getStatus() Gets the status of the marking (enumerated).
int	getStatusCode() Gets the status of the marking (enumerated).
String	getStatusName() Gets the name of the status of the marking (enumerated).
InformationExtractionTokenList	getTokenList() Gets the token list comprising the set of tokens for the marking.
boolean	isConfirmed() Returns true if this marking is confirmed.
protected void	postCreate(LibraryObjectDefinition lodef) Extensibility point to perform actions after the creation of a object.
protected void	preFree(LibraryObjectDefinition lodef) Extensibility point to perform actions prior to the permanent deletion ("free") of a object.
protected void	preUpdate(LibraryObjectDefinition lodef) Extensibility point to perform actions prior to the update of a object.
void	setEntityType(InformationExtractionEntityType entType) Sets the entity type for this marking.

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, hasNameAttribute, hasPropertyBundleAttribute, invalidateState, invokeOperation, invokeOperation, invokeServerMethod, isConnected, isCoreEventPostingEnabled, isInstanceOf, isPersistent, isTraced, lockRows, lookupInstanceLabel, performPostCreateExtensions, performPostFreeExtensions, performPostUpdateExtensions, performPreCreateExtensions, performPreFreeExtensions, performPreUpdateExtensions, postEvent, postEvent, postFree, postUpdate, preCreate, prePostAuditEvent, 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

INFORMATIONEXTRACTION_ATTRIBUTE

public static final String INFORMATIONEXTRACTION_ATTRIBUTE

The name of the Attribute representing The Information Extraction in which this marking was defined.

See Also:

Constant Field Values

ENTITYTYPE_ATTRIBUTE

public static final String ENTITYTYPE_ATTRIBUTE

The name of the Attribute representing The entity type of the marking.

See Also:

Constant Field Values

STATUS_ATTRIBUTE

public static final String STATUS_ATTRIBUTE

The name of the Attribute representing The status of the marking (enumerated).

See Also:

Constant Field Values

TOKENLIST_ATTRIBUTE

public static final String TOKENLIST_ATTRIBUTE

The name of the Attribute representing The token list comprising the set of tokens for the marking.

See Also:

Constant Field Values

CONFIDENCE_ATTRIBUTE

public static final String CONFIDENCE_ATTRIBUTE

The name of the Attribute representing The confidence level that this marking is correct (0.0 - 1.0).

See Also:

Constant Field Values

MARKINGDETAILS_ATTRIBUTE

public static final String MARKINGDETAILS_ATTRIBUTE

The name of the Attribute representing the details pertaining to the marking.

See Also:

Constant Field Values

STATUS_UNKNOWN

public static final int STATUS_UNKNOWN

The status value indicating the marking status is unknown.

See Also:

Constant Field Values

MARKINGSTATUS_UNCONFIRMED

public static final int MARKINGSTATUS_UNCONFIRMED

The status value indicating the marking is unconfirmed.

See Also:

Constant Field Values

STATUS_UNREVIEWED

public static final int STATUS_UNREVIEWED

The status value indicating the marking is unconfirmed.

Note this constant is retained for backwards compatibility.

See Also:

Constant Field Values

STATUS_REVIEWING

public static final int STATUS_REVIEWING

The status value indicating the marking is being reviewed.

See Also:

Constant Field Values

STATUS_CONFIRMED

public static final int STATUS_CONFIRMED

The status value indicating the marking has been confirmed.

See Also:

Constant Field Values

STATUS_ACCEPTED

public static final int STATUS_ACCEPTED

The status value indicating the marking has been confirmed.

Note this constant is retained for backwards compatibility.

See Also:

Constant Field Values

STATUS_REJECTED

public static final int STATUS_REJECTED

The status value indicating the marking has been reviewed and rejected.

See Also:

Constant Field Values

Constructor Detail

InformationExtractionOutcomeMarking

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

Construct a InformationExtractionOutcomeMarking object.

Parameters:

session - current LibrarySession

id - object id

classId - class id

data - data component

Throws:

IfsException - if the operation fails

Method Detail

getInformationExtraction

public InformationExtraction getInformationExtraction()
                                               throws IfsException

Gets the InformationExtraction in which this marking was defined.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getEntityType

public InformationExtractionEntityType getEntityType()
                                              throws IfsException

Gets entity type of the marking.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getStatusCode

public int getStatusCode()
                  throws IfsException

Gets the status of the marking (enumerated).

Returns:

the code of the status of the marking

Throws:

IfsException - if the operation fails

getStatus

public InformationExtractionOutcomeMarking.MarkingStatus getStatus()
                                                            throws IfsException

Gets the status of the marking (enumerated).

Returns:

the status of the marking

Throws:

IfsException - if the operation fails

getStatusName

public String getStatusName()
                     throws IfsException

Gets the name of the status of the marking (enumerated).

Returns:

the name of the status of the marking

Throws:

IfsException - if the operation fails

getTokenList

public InformationExtractionTokenList getTokenList()
                                            throws IfsException

Gets the token list comprising the set of tokens for the marking.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getConfidence

public double getConfidence()
                     throws IfsException

Gets the confidence level that this marking is correct (0.0 - 1.0).

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getMarkingDetails

public SimpleProperty[] getMarkingDetails()
                                   throws IfsException

Gets the details pertaining to the marking.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getMarkingText

public String getMarkingText()
                      throws IfsException

Gets text from the parsed text corresponding to this marking.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getSentenceNumber

public int getSentenceNumber()
                      throws IfsException

Gets the sentence number (zero based) in which the first token in the marking appears.

Returns:

the sentence number of the first token in the list

Throws:

IfsException - if the operation fails

getFirstTokenPosition

public int getFirstTokenPosition()
                          throws IfsException

Gets the token position of the first token in this marking's TokenList.

Returns:

the token position of the first token in the list

Throws:

IfsException - if the operation fails

getMarkingDetail

public AttributeValue getMarkingDetail(String propName)
                                throws IfsException

Gets the marking detail matching the specified property name.

Parameters:

propName - the property name

Returns:

the attribute's value, or null if no property matches that name

Throws:

IfsException - if the operation fails

isConfirmed

public boolean isConfirmed()
                    throws IfsException

Returns true if this marking is confirmed.

Returns:

true if this marking is confirmed; false otherwise

Throws:

IfsException - if the operation fails

setEntityType

public void setEntityType(InformationExtractionEntityType entType)
                   throws IfsException

Sets the entity type for this marking.

Parameters:

entType - the entity type

Throws:

IfsException - if the operation fails

addMarkingDetail

public void addMarkingDetail(String key,
                             AttributeValue value)
                      throws IfsException

Adds an marking detail (SimpleProperty) for this object.

Parameters:

key - the property's key

value - the property's value

Throws:

IfsException - if the operation fails

postCreate

protected void postCreate(LibraryObjectDefinition lodef)
                   throws IfsException

Extensibility point to perform actions after the creation of a object.

This method is typically overridden by subclasses that perform operations after an object is created. Subclasses are expected to invoke super.postCreate.

Overrides:

postCreate in class LibraryObject

Parameters:

lodef - object definition that was used to create the object

Throws:

IfsException - if operation fails.

preUpdate

protected void preUpdate(LibraryObjectDefinition lodef)
                  throws IfsException

Extensibility point to perform actions prior to the update of a object.

This method is typically overridden by subclasses that perform other operations prior to the target object being updated, in order to modify objects related to the target object. Subclasses are expected to invoke super.preUpdate.

Overrides:

preUpdate in class LibraryObject

Parameters:

lodef - object definition used to define how the target object will be updated

Throws:

IfsException - if operation fails.

preFree

protected void preFree(LibraryObjectDefinition lodef)
                throws IfsException

Description copied from class: LibraryObject

Extensibility point to perform actions prior to the permanent deletion ("free") of a object.

This method is typically overridden by subclasses that perform other operations prior to the target object being freed in order to all delete or modify objects related to the target object. Subclasses are expected to invoke super.preFree.

Overrides:

preFree in class LibraryObject

Parameters:

lodef - object definition used to hold options related to the free operation

Throws:

IfsException - if operation fails.