public class InformationExtractionDomainSpecification extends TieInformationExtractionAbstractSpecification
Modifier and Type | Field and Description |
---|---|
static String |
CLASS_NAME
The name of the ClassObject representing this class.
|
static String |
ENTITYPHRASES_ATTRIBUTE
The name of the Attribute representing
the set of InformationExtractionEntityPhrases for this domain.
|
static String |
ENTITYRELATIONTYPES_ATTRIBUTE
The name of the Attribute representing
the set of InformationExtractionEntityRelationTypes for this domain.
|
static String |
ENTITYTYPES_ATTRIBUTE
The name of the Attribute representing
the set of InformationExtractionEntityTypes for this domain.
|
static String |
IMPLICITENTITYRELATIONS_ATTRIBUTE
The name of the Attribute representing
the set of InformationExtractionImplicitEntityRelations for this domain.
|
static String |
LANGUAGE_ATTRIBUTE
The name of the Attribute representing
the domain's language.
|
static String |
NAME_ATTRIBUTE
The name of the Attribute representing
the name of the InformationExtractionDomainSpecification.
|
static String |
PHRASETABLESUFFIX_ATTRIBUTE
The name of the Attribute representing
the base name for the database objects used to store full text search
information for Entity Phrases.
|
static String |
PRETRAINEDENTITYNAMES_ATTRIBUTE
The name of the Attribute representing
the set of entity names used in pre-trained models.
|
static String |
REGEXMAPPINGS_ATTRIBUTE
The name of the Attribute representing the set of
InformationExtractionRegexMappings defined for this domain.
|
static String |
REGEXPATTERNS_ATTRIBUTE
The name of the Attribute representing the set of
InformationExtractionRegexPatterns defined for this domain.
|
static String |
REGEXRULES_ATTRIBUTE
The name of the Attribute representing the set of
InformationExtractionRegexRules defined for this domain.
|
static String |
SETTING_NAME_LEGALENTITYRELATIONS
The setting name for the Legal Entity relations.
|
static String |
STOPWORDS_ATTRIBUTE
The name of the Attribute representing
the set of stop words defined for this domain.
|
DESCRIPTION_ATTRIBUTE, SETTINGS_ATTRIBUTE
ACTIVE_ATTRIBUTE, POLICYBUNDLE_ATTRIBUTE, POLICYLISTS_ATTRIBUTE, PROPERTYBUNDLE_ATTRIBUTE
DOMAIN_UNIQUENAME_DEFAULT_DELIMITER, m_ClassId, m_Id, m_Session
Constructor and Description |
---|
InformationExtractionDomainSpecification(LibrarySession session,
Long id,
Long classId,
S_LibraryObjectData data)
Construct a InformationExtractionDomainSpecification object.
|
Modifier and Type | Method and Description |
---|---|
static InformationExtractionDomainSpecification[] |
findAll(LibrarySession session)
Returns the set of defined InformationExtractionDomainSpecifications.
|
static InformationExtractionDomainSpecification |
findByName(LibrarySession session,
String name)
Returns the a InformationExtractionDomainSpecification matching the
specified name.
|
InformationExtractionEntityPhrase[] |
getEntityPhrases()
Gets the set of InformationExtractionEntityPhrases for this domain.
|
Map<String,InformationExtractionEntityRelationType> |
getEntityRelationTypeMap()
Gets a map of the InformationExtractionEntityRelationTypes defined for this domain,
keyed by the uppercased InformationExtractionEntityRelationType name.
|
InformationExtractionEntityRelationType[] |
getEntityRelationTypes()
Gets the set of InformationExtractionEntityRelationTypes for this domain.
|
Map<String,InformationExtractionEntityType> |
getEntityTypeMap()
Gets a map of the InformationExtractionEntityTypes defined for this domain,
keyed by the uppercased InformationExtractionEntityType name.
|
InformationExtractionEntityType[] |
getEntityTypes()
Gets the set of InformationExtractionEntityTypes for this domain.
|
InformationExtractionImplicitEntityRelation[] |
getImplicitEntityRelations()
Gets the set of InformationExtractionImplicitEntityRelations for this domain.
|
String |
getLanguage()
Gets the domain's language.
|
InformationExtractionLegalEntityRelation[] |
getLegalEntityRelations()
Gets the set of legal EntityRelations for this domain.
|
Map<String,InformationExtractionLegalEntityRelation> |
getLegalEntityRelationsMap()
Gets the Legal entity relation map, keyed by the uppercased
aggregate of {sourceEntity,targetEntity,relType}, and value is the
InformationExtractionLegalEntityRelation object that describes the legal relation.
|
static LibraryObjectLookupCache |
getLibraryObjectLookupCache(LibrarySession session)
Returns the LibraryObjectLookupCache used by find
InformationExtractionDomainSpecification instances by name.
|
String |
getPhraseTableSuffix()
Gets the base name for the database objects used to store full text search
information for Entity Phrases.
|
String[] |
getPreTrainedEntityNames()
Gets the set of entity names used in pre-trained models.
|
InformationExtractionRegexMapping[] |
getRegexMappings()
Gets the set of InformationExtractionRegexMappings defined
for this domain.
|
Map<String,String> |
getRegexMappingsMap()
Gets the RegexMappings map, keyed by the uppercased
NER result tag, and value is the mapped EntityType name.
|
InformationExtractionRegexPattern[] |
getRegexPatterns()
Gets the set of InformationExtractionRegexPatterns defined for this domain.
|
InformationExtractionRegexRule[] |
getRegexRules()
Gets the set of InformationExtractionRegexRules defined
for this domain.
|
Map<String,String> |
getStopWordMap()
Gets a map of the stop words defined for this domain,
keyed by the uppercased stop word name.
|
String[] |
getStopWords()
Gets the set of stop words defined for this domain..
|
boolean |
hasNameAttribute()
Returns true if this object is an instance of a class
that has a NAME attribute, and false otherwise.
|
boolean |
isLegalEntityRelation(Map<String,InformationExtractionLegalEntityRelation> legalRelMap,
String srcEntName,
String trgEntName,
String relName)
Checks to see if the relation info specified reflects a legal
entity relation for this domain.
|
protected void |
postCreate(LibraryObjectDefinition lodef)
Extensibility point to perform actions after the
creation of a SystemObject.
|
protected void |
preCreate(LibraryObjectDefinition lodef)
Extensibility point to perform actions prior to the
creation of a PublicObject.
|
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 PublicObject.
|
void |
writeCoreNlpRegexRuleTrainingOutputFile(String path)
Writes the CoreNLP REGEX Rule output file that will contain the set of
all REGEX rules defined by this DomainSpecification.
|
void |
writeRegexPatternTrainingOutputFile(String path)
Writes the REGEX Pattern output file that will contain the set of
all REGEX patterns defined by this DomainSpecification.
|
addSetting, getDescription, getSetting, getSettings
addCategory, constructSystemObject, constructSystemObjectVector, free, freeCategories, getCategories, getCategories, getCategories, getCategories, getPolicyBundle, getPolicyLists, handleCreate, hasPropertyBundleAttribute, isActive, postUpdate, putPolicy, removeAllPolicies, removePolicy, removePolicy, setActive, setPolicyBundle, setPolicyLists
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, invalidateState, invokeOperation, invokeOperation, invokeServerMethod, isConnected, isCoreEventPostingEnabled, isInstanceOf, isPersistent, isTraced, isValidEventType, lockRows, lookupInstanceLabel, performPostCreateExtensions, performPostFreeExtensions, performPostUpdateExtensions, performPreCreateExtensions, performPreFreeExtensions, performPreUpdateExtensions, postEvent, postEvent, postFree, 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
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
getAttributeByUpperCaseName, getClassId, getId, getSessionInterface
getTraceLogger, isTraced, trace
public static final String CLASS_NAME
public static final String NAME_ATTRIBUTE
public static final String LANGUAGE_ATTRIBUTE
public static final String PHRASETABLESUFFIX_ATTRIBUTE
public static final String ENTITYTYPES_ATTRIBUTE
public static final String ENTITYRELATIONTYPES_ATTRIBUTE
public static final String IMPLICITENTITYRELATIONS_ATTRIBUTE
public static final String ENTITYPHRASES_ATTRIBUTE
public static final String REGEXPATTERNS_ATTRIBUTE
public static final String REGEXRULES_ATTRIBUTE
public static final String REGEXMAPPINGS_ATTRIBUTE
public static final String STOPWORDS_ATTRIBUTE
public static final String PRETRAINEDENTITYNAMES_ATTRIBUTE
public static final String SETTING_NAME_LEGALENTITYRELATIONS
public InformationExtractionDomainSpecification(LibrarySession session, Long id, Long classId, S_LibraryObjectData data) throws IfsException
session
- current LibrarySessionid
- object idclassId
- class iddata
- data componentIfsException
- if the operation failspublic boolean hasNameAttribute() throws IfsException
LibraryObject
hasNameAttribute
in class InformationExtractionAbstractSpecification
IfsException
- if operation fails.public String getLanguage() throws IfsException
IfsException
- if operation failspublic String getPhraseTableSuffix() throws IfsException
IfsException
- if operation failspublic InformationExtractionEntityType[] getEntityTypes() throws IfsException
IfsException
- if the operation failspublic InformationExtractionEntityRelationType[] getEntityRelationTypes() throws IfsException
IfsException
- if the operation failspublic InformationExtractionLegalEntityRelation[] getLegalEntityRelations() throws IfsException
IfsException
- if the operation failspublic InformationExtractionImplicitEntityRelation[] getImplicitEntityRelations() throws IfsException
IfsException
- if the operation failspublic InformationExtractionEntityPhrase[] getEntityPhrases() throws IfsException
IfsException
- if the operation failspublic InformationExtractionRegexPattern[] getRegexPatterns() throws IfsException
IfsException
- if the operation failspublic InformationExtractionRegexRule[] getRegexRules() throws IfsException
IfsException
- if the operation failspublic InformationExtractionRegexMapping[] getRegexMappings() throws IfsException
IfsException
- if the operation failspublic String[] getStopWords() throws IfsException
IfsException
- if the operation failspublic String[] getPreTrainedEntityNames() throws IfsException
IfsException
- if the operation failspublic Map<String,InformationExtractionEntityType> getEntityTypeMap() throws IfsException
IfsException
- if the operation failspublic Map<String,InformationExtractionEntityRelationType> getEntityRelationTypeMap() throws IfsException
IfsException
- if the operation failspublic Map<String,String> getStopWordMap() throws IfsException
IfsException
- if the operation failspublic Map<String,String> getRegexMappingsMap() throws IfsException
IfsException
- if the operation failspublic Map<String,InformationExtractionLegalEntityRelation> getLegalEntityRelationsMap() throws IfsException
IfsException
- if the operation failspublic boolean isLegalEntityRelation(Map<String,InformationExtractionLegalEntityRelation> legalRelMap, String srcEntName, String trgEntName, String relName) throws IfsException
legalRelMap
- The map that defines the legal relations for this
domain; can be obtained from getLegalEntityRelationsMap();
if null, create one on the flysrcEntName
- The name of the source entity typetrgEntName
- The name of the target entity typerelName
- The name of the relation typeIfsException
- if the operation failspublic void writeRegexPatternTrainingOutputFile(String path) throws IfsException
path
- the File path to write the training outputIfsException
- if the operation failspublic void writeCoreNlpRegexRuleTrainingOutputFile(String path) throws IfsException
path
- the File path to write the training outputIfsException
- if the operation failspublic static LibraryObjectLookupCache getLibraryObjectLookupCache(LibrarySession session) throws IfsException
session
- the session contextIfsException
- if the operation fails.public static InformationExtractionDomainSpecification[] findAll(LibrarySession session) throws IfsException
The instances will be sorted by name.
session
- the session contextIfsException
- if the operation fails.public static InformationExtractionDomainSpecification findByName(LibrarySession session, String name) throws IfsException
InformationExtractionDomainSpecification names are case sensitive, so this operations requires an exact match with respect to case.
session
- the session contextname
- the InformationExtractionDomainSpecification nameIfsException
- if the operation fails.protected void preCreate(LibraryObjectDefinition lodef) throws IfsException
SystemObject
Set an option that indicates that Categories are NOT to be created from within S_SystemObject.
preCreate
in class SystemObject
lodef
- object definition that will be used to create the objectIfsException
- if operation failsprotected void postCreate(LibraryObjectDefinition lodef) throws IfsException
SystemObject
This assumes that a transaction context has already been established.
postCreate
in class InformationExtractionAbstractSpecification
lodef
- object definition that was used to create the objectIfsException
- if operation failsprotected void preUpdate(LibraryObjectDefinition lodef) throws IfsException
SystemObject
Set an option that indicates that Categories are NOT to be created from within S_SystemObject.
preUpdate
in class InformationExtractionAbstractSpecification
lodef
- definition used to define how the target object
will be updatedIfsException
- if operation failsprotected void preFree(LibraryObjectDefinition lodef) throws IfsException
LibraryObject
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
.
preFree
in class InformationExtractionAbstractSpecification
lodef
- object definition used to hold options related to the free
operationIfsException
- if operation fails.Copyright © 2023. All rights reserved.