oracle.ifs.core.tools.script.test.overrides.cyber.beans

Class StixReport

java.lang.Object

oracle.ifs.beans.LibraryObject

oracle.ifs.beans.TieLibraryObject

oracle.ifs.beans.PublicObject

oracle.ifs.beans.TiePublicObject

oracle.ifs.beans.ApplicationObject

oracle.ifs.beans.TieApplicationObject

oracle.ifs.core.tools.script.test.overrides.cyber.beans.StixDomainObject

oracle.ifs.core.tools.script.test.overrides.cyber.beans.StixReport

All Implemented Interfaces:

Comparable, IfsEventHandler, LibraryObjectInterface, LooselyBoundedCacheable, PublicObjectInterface, Traceable

public class StixReport
extends StixDomainObject

A StixReport represents a STIX 2.0 Report.

Author:

Dave Long

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLASS_NAME The name of the ClassObject representing this class.
static String	INFORMATIONEXTRACTION_ATTRIBUTE The name of the Attribute representing The NLP information extraction of the source document.
static String	INPUTFORMAT_ATTRIBUTE The name of the Attribute representing The input format of the Report (json, csv, def).
static String	PUBLISHEDDATE_ATTRIBUTE The name of the Attribute representing The time this Report was published.
static String	REPORTFOLDER_ATTRIBUTE The name of the Attribute representing The folder used to hold the artifacts for this Report.
static String	SOURCEDOCUMENT_ATTRIBUTE The name of the Attribute representing The source document for this Report.
static String	TOKENSDOCUMENT_ATTRIBUTE The name of the Attribute representing The text document holding the tokens correspoinding to the Source Document of this Report.
static String	TYPE_ATTRIBUTE The name of the Attribute representing The type of the Report (training, test, evaluation).

Fields inherited from class oracle.ifs.core.tools.script.test.overrides.cyber.beans.StixDomainObject

ALIASES_ATTRIBUTE, CANONICALNAME_ATTRIBUTE, DESCRIPTIONDOCUMENT_ATTRIBUTE, EXTERNALREFERENCES_ATTRIBUTE, FIRSTSEEN_ATTRIBUTE, IDENTITYCREATOR_ATTRIBUTE, INDEXEDNAME_ATTRIBUTE, INDEXEDNAMELANGUAGE_ATTRIBUTE, LABELS_ATTRIBUTE, LASTSEEN_ATTRIBUTE, REPORT_ATTRIBUTE, STATUS_ATTRIBUTE

Fields inherited from class oracle.ifs.beans.PublicObject

ACL_ATTRIBUTE, CREATEDATE_ATTRIBUTE, CREATOR_ATTRIBUTE, DELETOR_ATTRIBUTE, DESCRIPTION_ATTRIBUTE, EXPIRATIONDATE_ATTRIBUTE, FAMILY_ATTRIBUTE, FLAG_CATEGORY_EXISTS, FLAG_CONFIGURATIONCATEGORY_EXISTS, FLAG_MARKED, FLAG_NOINFERIOR, FLAG_NOSELECT, FLAG_NTFS_ARCHIVE, FLAG_NTFS_HIDDEN, FLAG_NTFS_READONLY, FLAG_NTFS_SYSTEM, FLAG_UNMARKED, FLAGS_ATTRIBUTE, LASTMODIFIER_ATTRIBUTE, LASTMODIFYDATE_ATTRIBUTE, LOCKENTRIES_ATTRIBUTE, LOCKOBJECT_ATTRIBUTE, NAME_ATTRIBUTE, OWNER_ATTRIBUTE, POLICYBUNDLE_ATTRIBUTE, POLICYLISTS_ATTRIBUTE, PRIMARYPARENTFOLDER_ATTRIBUTE, PROPERTYBUNDLE_ATTRIBUTE, RESOLVEDPUBLICOBJECT_ATTRIBUTE, SECURINGPUBLICOBJECT_ATTRIBUTE

Fields inherited from class oracle.ifs.beans.LibraryObject

DOMAIN_UNIQUENAME_DEFAULT_DELIMITER, m_ClassId, m_Id, m_Session

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static StixReport	createFromInformationExtraction(InformationExtraction ext) Creates a StixReport from an InformationExtraction.
String	deriveSummaryText() Gets the alternate outcomes produced from the NLP analysis.
static StixReport	findFromInformationExtraction(InformationExtraction ext) Finds a StixReport from an InformationExtraction.
StixDomainObject[]	getCreatedDomainObjects() Gets the StixDomainObjects created as part of creating a StixReport from a solved/finished InformationExtraction.
StixRelationObject[]	getCreatedRelationObjects() Gets the StixRelationObjects created as part of creating a StixReport from a solved/finished InformationExtraction.
InformationExtraction	getInformationExtraction() Gets the NLP extraction of the source document.
String	getInputFormat() Gets the input format of the Report (json, csv, def).
Date	getPublishedDate() Gets the time this Report was published.
Folder	getReportFolder() Gets the folder used to hold the artifacts for this Report.
Document	getSourceDocument() Gets the source document for this Report.
Document	getTokensDocument() Gets the text document holding the tokens correspoinding to the Source Document of this Report.
String	getType() Gets the type of the Report (training, test, evaluation).
void	setInputFormat(String val) Sets The input format of the Report (json, csv, def).
void	setPublishedDate(Date val) Sets The time this Report was published.
void	setReportFolder(Folder val) Sets The folder used to hold the artifacts for this Report.
void	setSourceDocument(Document val) Sets The source document for this Report.
void	setTokensDocument(Document val) Sets The text document holding the tokens correspoinding to the Source Document of this Report.
void	setType(String val) Sets The type of the Report (training, test, evaluation).

Methods inherited from class oracle.ifs.core.tools.script.test.overrides.cyber.beans.StixDomainObject

getAliases, getCanonicalName, getDescriptionDocument, getExternalReferences, getFirstSeen, getIdentityCreator, getIndexedName, getLabels, getLastSeen, getReferencingStixRelationObjects, getReport, getStatus, getStixRelationObjects, preCreate, setAliases, setCanonicalName, setDescriptionDocument, setExternalReferences, setFirstSeen, setIdentityCreator, setLabels, setLastSeen

Methods inherited from class oracle.ifs.beans.ApplicationObject

auditPublicObjectLocked, auditPublicObjectUnlocked, auditUpdated, constructApplicationObject, constructApplicationObjectVector, isValidEventType, postCreate, preFree, reportApplicationObjectCreated, reportApplicationObjectFreed

Methods inherited from class oracle.ifs.beans.PublicObject

addAccess, addAttachment, addCategory, addFlags, addMessageList, addRelationship, canAcquireManualLock, canReleaseDavLock, canReleaseLock, canReleaseManualLock, capabilities, checkAuditViewCapability, checkCapabilities, checkCapability, checkEffectiveAccess, checkEffectiveAccess, checkLockAccess, checkParentFolderCapability, checkVersioned, clearFlags, constructPublicObject, constructPublicObjectArray, constructPublicObjectVector, containsLockEntry, copy, coreAutoFolderingEnabled, createCategories, createDedicatedPolicyPropertyBundle, delete, deriveEffectiveAccessLevel, findAttachmentRelation, findOrAddActivityRecord, findOrAddActivityRecord, findOrAddActor, findOrAddActor, findOrAddMessageList, findOrAddMessageList, free, getAcl, getActivityRecord, getActor, getAllFolderPaths, getAllFolderPaths, getAllFolderPaths, getAnyFolderPath, getAnyFolderPath, getAnyFolderPath, getAttachmentRelation, getAttachmentRelations, getAttachments, getCapabilities, getCategories, getCategories, getCategories, getCategories, getCategories, getCategory, getConsumedStorage, getCreateDate, getCreator, getDefaultAccessLevel, getDefinitionForSimplePropertyUpdates, getDeletor, getDescription, getEffectiveAccessLevel, getEffectiveAccessLevel, getExpirationDate, getFamily, getFirstCategory, getFirstVersion, getFlags, getFolderReferences, getFolderReferences, getFolderReferencesSortSpecification, getLastModifier, getLastModifyDate, getLastVersion, getLeftwardRelationshipObjects, getLeftwardRelationshipObjects, getLeftwardRelationships, getLeftwardRelationships, getLeftwardRelationshipsCount, getLeftwardRelationshipsCount, getLinks, getLockEntries, getLockEntries, getLockObject, getLockRestrictions, getLockTypeAuditProperties, getMessageList, getNextVersion, getOwner, getPolicyBundle, getPolicyLists, getPreviousVersion, getPrimaryFolderPath, getPrimaryParentFolder, getPrimaryParentFolder, getRelations, getReservationComment, getReservationDate, getReservor, getResolvedPublicObject, getRestrictingLockEntries, getRightwardRelationshipObjects, getRightwardRelationshipObjects, getRightwardRelationships, getRightwardRelationships, getSecuringPublicObject, getSingletonVersionDescription, getVersionNumber, getVersions, getVersionSeries, getWorkingCopy, grantAccess, handleCopy, handleCreate, handleUnlockAll, hasActivityRecord, hasActor, hasAttachmentRelation, hasCategories, hasCategory, hasConfigurationCategories, hasMessageList, hasNameAttribute, hasPropertyBundleAttribute, isAttachment, isDeleted, isLatestVersion, isLocked, isLockingSupported, isOwner, isReserved, isReservedByCurrentUser, isVersionable, isVersioned, isWorkingCopy, listLeftwardRelationships, listRightwardRelationships, lock, lock, lock, lock, newVersion, postCopy, postSecurityChangedEvent, postUpdate, preCopy, preUpdate, putPolicy, reassociateLinks, removeAllPolicies, removeAttachment, removePolicy, removePolicy, removeRelationship, reserveNext, resetFolderReferences, resolveFolderReferenceSortSpecification, revokeAccess, revokeAllAccess, setAcl, setDescription, setExpirationDate, setFlags, setFolderReferencesSortSpecification, setLockEntries, setLockEntrySecurity, setOwner, setOwnerByName, setPolicyBundle, setPolicyLists, setSecuringPublicObject, toPublicObjectArray, undelete, unlock, unlock, unlockAll, unReserve, updateFlags, updateLock, vectorPublicObjectElement, vectorToPublicObjectArray, verifyAddRelationshipCapability, verifyCapabilities, verifyCapability, verifyDeleteCapability, verifyLockCapability, verifyRemoveRelationshipCapability, verifyUnlockCapability, verifyVersionSeries

Methods inherited from class oracle.ifs.beans.LibraryObject

added, addSimpleProperty, addSimpleProperty, applyProperties, auditCreated, 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, 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, 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

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 NLP information extraction of the source document.

See Also:

Constant Field Values

REPORTFOLDER_ATTRIBUTE

public static final String REPORTFOLDER_ATTRIBUTE

The name of the Attribute representing The folder used to hold the artifacts for this Report.

See Also:

Constant Field Values

SOURCEDOCUMENT_ATTRIBUTE

public static final String SOURCEDOCUMENT_ATTRIBUTE

The name of the Attribute representing The source document for this Report.

See Also:

Constant Field Values

TOKENSDOCUMENT_ATTRIBUTE

public static final String TOKENSDOCUMENT_ATTRIBUTE

The name of the Attribute representing The text document holding the tokens correspoinding to the Source Document of this Report.

See Also:

Constant Field Values

PUBLISHEDDATE_ATTRIBUTE

public static final String PUBLISHEDDATE_ATTRIBUTE

The name of the Attribute representing The time this Report was published.

See Also:

Constant Field Values

TYPE_ATTRIBUTE

public static final String TYPE_ATTRIBUTE

The name of the Attribute representing The type of the Report (training, test, evaluation).

See Also:

Constant Field Values

INPUTFORMAT_ATTRIBUTE

public static final String INPUTFORMAT_ATTRIBUTE

The name of the Attribute representing The input format of the Report (json, csv, def).

See Also:

Constant Field Values

Constructor Detail

StixReport

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

Construct a StixReport 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 NLP extraction of the source document.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getReportFolder

public Folder getReportFolder()
                       throws IfsException

Gets the folder used to hold the artifacts for this Report.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getSourceDocument

public Document getSourceDocument()
                           throws IfsException

Gets the source document for this Report.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getTokensDocument

public Document getTokensDocument()
                           throws IfsException

Gets the text document holding the tokens correspoinding to the Source Document of this Report.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getPublishedDate

public Date getPublishedDate()
                      throws IfsException

Gets the time this Report was published.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getType

public String getType()
               throws IfsException

Gets the type of the Report (training, test, evaluation).

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getInputFormat

public String getInputFormat()
                      throws IfsException

Gets the input format of the Report (json, csv, def).

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

deriveSummaryText

public String deriveSummaryText()
                         throws IfsException

Gets the alternate outcomes produced from the NLP analysis.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

setReportFolder

public void setReportFolder(Folder val)
                     throws IfsException

Sets The folder used to hold the artifacts for this Report.

Parameters:

val - the new value

Throws:

IfsException - if the operation fails

setSourceDocument

public void setSourceDocument(Document val)
                       throws IfsException

Sets The source document for this Report.

Parameters:

val - the new value

Throws:

IfsException - if the operation fails

setTokensDocument

public void setTokensDocument(Document val)
                       throws IfsException

Sets The text document holding the tokens correspoinding to the Source Document of this Report.

Parameters:

val - the new value

Throws:

IfsException - if the operation fails

setPublishedDate

public void setPublishedDate(Date val)
                      throws IfsException

Sets The time this Report was published.

Parameters:

val - the new value

Throws:

IfsException - if the operation fails

setType

public void setType(String val)
             throws IfsException

Sets The type of the Report (training, test, evaluation).

Parameters:

val - the new value

Throws:

IfsException - if the operation fails

setInputFormat

public void setInputFormat(String val)
                    throws IfsException

Sets The input format of the Report (json, csv, def).

Parameters:

val - the new value

Throws:

IfsException - if the operation fails

getCreatedDomainObjects

public StixDomainObject[] getCreatedDomainObjects()
                                           throws IfsException

Gets the StixDomainObjects created as part of creating a StixReport from a solved/finished InformationExtraction.

Returns:

the StixDomainObjects that were created

Throws:

IfsException - if the operation fails

(Unpublished)

getCreatedRelationObjects

public StixRelationObject[] getCreatedRelationObjects()
                                               throws IfsException

Gets the StixRelationObjects created as part of creating a StixReport from a solved/finished InformationExtraction.

Returns:

the StixRelationObjects that were created

Throws:

IfsException - if the operation fails

(Unpublished)

createFromInformationExtraction

public static StixReport createFromInformationExtraction(InformationExtraction ext)
                                                  throws IfsException

Creates a StixReport from an InformationExtraction.

Parameters:

ext - the InformationExtraction

Returns:

the StixReport

Throws:

IfsException - if the operation fails

findFromInformationExtraction

public static StixReport findFromInformationExtraction(InformationExtraction ext)
                                                throws IfsException

Finds a StixReport from an InformationExtraction.

Parameters:

ext - the InformationExtraction

Returns:

the StixReport

Throws:

IfsException - if the operation fails