Class SalienceCollections

java.lang.Object
com.lexalytics.salience.SalienceCollections
All Implemented Interfaces:
ISalienceCollections

public class SalienceCollections
extends java.lang.Object
implements ISalienceCollections

The SalienceCollections object encapsulates the collection-level text analytics functionality available from Salience Engine. The object represents a Salience session for handling collections of documents, and allows the user to process the collection for entities, sentiment, themes, facets, etc.

You can have multiple Salience sessions active at the same time, either to increase throughput or to process documents with different sets of customizations to the data directory. However, you should NOT instantiate a new Salience session for each document to be processed.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface com.lexalytics.salience.ISalienceCollections

    ISalienceCollections.Warning
  • Field Summary

    Fields 
    Modifier and Type Field Description
    Options Options
    Access to the Options for this Salience session.
  • Constructor Summary

    Constructors 
    Constructor Description
    SalienceCollections​(java.lang.String sLicenseFile, java.lang.String sDataPath)
    Creates a new SalienceCollections session.
    SalienceCollections​(java.lang.String sLicenseFile, java.lang.String sDataPath, boolean bShortContentMode)
    Creates a new SalienceCollections session.
    SalienceCollections​(java.lang.String sLicenseFile, java.lang.String sDataPath, java.lang.String sLogPath)
    Creates a new SalienceCollections session.
    SalienceCollections​(java.lang.String sLicenseFile, java.lang.String sDataPath, java.lang.String sLogPath, boolean bShortContentMode)
    Creates a new SalienceCollections session.
    SalienceCollections​(java.lang.String sLicenseFile, java.lang.String sDataPath, java.lang.String sLogPath, java.lang.String sLogConfigurationPath, boolean bShortContentMode)
    Creates a new SalienceCollections session.
  • Method Summary

    Modifier and Type Method Description
    void addSalienceConfiguration​(java.lang.String sUserPath, java.lang.String sConfigurationID)
    Add a user directory session.
    void disableCallback​(boolean bDisable)
    Enables or disables callback messaging
    void disableCallback​(boolean bDisable, java.lang.String sConfigurationID)
    Enables or disables callback messaging
    void dispose()
    Frees all resources associated with this Salience session.
    java.util.Vector<Topic> getCollectionConceptDefinedTopics()
    Returns a list of topic labels identified for the collection via concepts.
    java.util.Vector<Topic> getCollectionConceptDefinedTopics​(java.lang.String sConfigurationID)
    Returns a list of topic labels identified for the collection via concepts.
    CollectionDetails getCollectionDetails()
    Retrieves details about the collection.
    CollectionDetails getCollectionDetails​(java.lang.String sConfigurationID)
    Retrieves details about the collection.
    java.util.Vector<CollectionEntity> getCollectionEntities()
    Retrieves a list of named entities from the documents in the collection.
    java.util.Vector<CollectionEntity> getCollectionEntities​(java.lang.String sConfigurationID)
    Retrieves a list of named entities from the documents in the collection.
    java.util.Vector<Facet> getCollectionFacets()
    Retrieves facets aggregated across all documents in the collection.
    java.util.Vector<Facet> getCollectionFacets​(java.lang.String sConfigurationID)
    Retrieves facets aggregated across all documents in the collection.
    java.util.Vector<Topic> getCollectionQueryDefinedTopics()
    Returns a list of topic labels identified for the documents in the collection via queries.
    java.util.Vector<Topic> getCollectionQueryDefinedTopics​(java.lang.String sConfigurationID)
    Returns a list of topic labels identified for the documents in the collection via queries.
    java.util.Vector<Theme> getCollectionThemes()
    Retrieves themes aggregated across all documents in the collection.
    java.util.Vector<Theme> getCollectionThemes​(java.lang.String sConfigurationID)
    Retrieves themes aggregated across all documents in the collection.
    java.util.Vector<CollectionEntity> getCollectionUserEntities()
    Retrieves a list of user entities from the documents in the collection.
    java.util.Vector<CollectionEntity> getCollectionUserEntities​(java.lang.String sConfigurationID)
    Retrieves a list of user entities from the documents in the collection.
    java.util.EnumSet<ISalienceCollections.Warning> getLastWarnings()
    Options getOptions()  
    void prepareCollectionFromFile​(java.lang.String sCollectionName, java.lang.String sFile)
    Prepares a CSV file from disk for analysis.
    void prepareCollectionFromVector​(java.lang.String sCollectionName, java.util.Vector<java.lang.String> vDocuments)
    Prepares the supplied collection for analysis.
    void removeSalienceConfiguration​(java.lang.String sConfigurationID)
    Remove a user directory session.
    void SetOption​(int id, boolean value, java.lang.String sConfigurationID)
    Sets an option that requires a boolean value.
    void SetOption​(int id, float value, java.lang.String sConfigurationID)
    Sets an option that requires a float value.
    void SetOption​(int id, int value, java.lang.String sConfigurationID)
    Sets an option that requires an integer value.
    void SetOption​(int id, int intValue, java.lang.String stringValue, java.lang.String sConfigurationID)
    Sets an option that requires a String value and an integer value.
    void SetOption​(int id, java.lang.String value, java.lang.String sConfigurationID)
    Sets an option that requires a String value.
    void SetOptionsWithFile​(java.lang.String sOptionPath, java.lang.String sConfigurationID)
    Sets all options specified in the provided tab delimited file
    void SetOptionWithString​(java.lang.String sOption, java.lang.String sConfigurationID)
    Sets all options specified in the provided String

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait