TriggerDictionaryInfo (platform/sdk 5.5.1.0-SNAPSHOT API)

java.lang.Object
- com.attivio.sdk.client.trigger.TriggerDictionaryInfo

All Implemented Interfaces:

Serializable, Cloneable
```
public class TriggerDictionaryInfo
extends Object
implements Cloneable, Serializable
```
Defines a dictionary of triggers.
This dictionary can then be used for performing entity extraction based on complex queries.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_ENTITY_NAME_FIELD` Default name for output field that contains the entities for matching triggers.
`static boolean`	`DEFAULT_ENTITY_NAME_SCOPES` Default for `isEntityNameScopes()`
`static String`	`DEFAULT_ENTITY_SCORE_FIELD` Default name for dynamic field that contains per-entity scores.
`static String`	`DEFAULT_TRIGGER_NAME_FIELD` Default name for output field that contains the names of matching triggers.
`static boolean`	`DEFAULT_TRIGGER_NAME_SCOPES` Default for `isTriggerNameScopes()`
`static String`	`DEFAULT_TRIGGER_SCORE_FIELD` Default name for trigger score output field.
`static String`	`DEFAULT_TRIGGER_VERSION_FIELD` Default name for the output field that contains the trigger dictionary's version number.

Constructor Summary

Constructors
Constructor and Description

TriggerDictionaryInfo()

TriggerDictionaryInfo(String name)

Constructors
Constructor and Description
`TriggerDictionaryInfo()`
`TriggerDictionaryInfo(String name)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TriggerDictionaryInfo`	`clone()`
`boolean`	`equals(Object other)`
`String`	`getEntityNameField()` Get the name of the output field for storing the entity names for matching triggers.
`String`	`getEntityScoreField()` Get the name of the output field for storing the per-entity scores for matching triggers.
`String`	`getName()` Get the name of this dictionary.
`String`	`getSchemaName()` Get the name of the schema to use for processing queries and documents.
`String`	`getSynonymDictionary()` Get the name of the synonym dictionary to use for synonym expansion.
`String`	`getTriggerNameField()` Get the name of the output field for storing the names of matching triggers.
`String`	`getTriggerScoreField()` Get the name of the output field for storing aggregate score for all matching triggers.
`String`	`getTriggerVersionField()` Get the name of the output field that will contain a version identifer for the dictionary used to apply triggers.
`int`	`hashCode()`
`boolean`	`isCompiled()` Get if all outstanding changes to this dictionary have been compiled.
`boolean`	`isEntityNameScopes()` If `true` scopes will be added for entity names for matching triggers.
`boolean`	`isPublished()` Get if all outstanding changes to this dictionary have been published.
`boolean`	`isTriggerNameScopes()` If `true` scopes will be added for trigger names for matching triggers.
`void`	`setCompiled(boolean value)` Set if all outstanding changes to this dictionary have been compiled.
`void`	`setEntityNameField(String value)` Set the name of the output field for storing the entity names for matching triggers.
`void`	`setEntityNameScopes(boolean value)` If `true` scopes will be added for entity names for matching triggers.
`void`	`setEntityScoreField(String value)` Set the name of the output field for storing the per-entity scores for matching triggers.
`void`	`setName(String value)` Set the name of this dictionary.
`void`	`setPublished(boolean value)` Set if all outstanding changes to this dictionary have been published.
`void`	`setSchemaName(String value)` Set the name of the schema to use for processing queries and documents.
`void`	`setSynonymDictionary(String value)` Set the name of the synonym dictionary to use for synonym expansion.
`void`	`setTriggerNameField(String value)` Set the name of the output field for storing the names of matching triggers.
`void`	`setTriggerNameScopes(boolean value)` If `true` scopes will be added for trigger names for matching triggers.
`void`	`setTriggerScoreField(String value)` Set the name of the output field for storing aggregate score for all matching triggers.
`void`	`setTriggerVersionField(String value)` Set the name of the output field that will contain a version identifer for the dictionary used to apply triggers.
`String`	`toString()`

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_TRIGGER_NAME_FIELD
```
public static final String DEFAULT_TRIGGER_NAME_FIELD
```
    Default name for output field that contains the names of matching triggers.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_TRIGGER_SCORE_FIELD
```
public static final String DEFAULT_TRIGGER_SCORE_FIELD
```
    Default name for trigger score output field.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_ENTITY_NAME_FIELD
```
public static final String DEFAULT_ENTITY_NAME_FIELD
```
    Default name for output field that contains the entities for matching triggers.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_TRIGGER_VERSION_FIELD
```
public static final String DEFAULT_TRIGGER_VERSION_FIELD
```
    Default name for the output field that contains the trigger dictionary's version number.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_ENTITY_SCORE_FIELD
```
public static final String DEFAULT_ENTITY_SCORE_FIELD
```
    Default name for dynamic field that contains per-entity scores.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_TRIGGER_NAME_SCOPES
```
public static final boolean DEFAULT_TRIGGER_NAME_SCOPES
```
    Default for isTriggerNameScopes()
    
    See Also:
    
    Constant Field Values
  - DEFAULT_ENTITY_NAME_SCOPES
```
public static final boolean DEFAULT_ENTITY_NAME_SCOPES
```
    Default for isEntityNameScopes()
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TriggerDictionaryInfo
```
public TriggerDictionaryInfo()
```
  - TriggerDictionaryInfo
```
public TriggerDictionaryInfo(String name)
```
- Method Detail
  - getName
```
public String getName()
```
    Get the name of this dictionary.
  - setName
```
public void setName(String value)
```
    Set the name of this dictionary.
  - getSchemaName
```
public String getSchemaName()
```
    Get the name of the schema to use for processing queries and documents.
  - setSchemaName
```
public void setSchemaName(String value)
```
    Set the name of the schema to use for processing queries and documents.
  - getSynonymDictionary
```
public String getSynonymDictionary()
```
    Get the name of the synonym dictionary to use for synonym expansion.
  - setSynonymDictionary
```
public void setSynonymDictionary(String value)
```
    Set the name of the synonym dictionary to use for synonym expansion.
  - isCompiled
```
public boolean isCompiled()
```
    Get if all outstanding changes to this dictionary have been compiled.
  - setCompiled
```
public void setCompiled(boolean value)
```
    Set if all outstanding changes to this dictionary have been compiled.
  - isPublished
```
public boolean isPublished()
```
    Get if all outstanding changes to this dictionary have been published.
  - setPublished
```
public void setPublished(boolean value)
```
    Set if all outstanding changes to this dictionary have been published.
  - getTriggerVersionField
```
public String getTriggerVersionField()
```
    Get the name of the output field that will contain a version identifer for the dictionary used to apply triggers.
  - setTriggerVersionField
```
public void setTriggerVersionField(String value)
```
    Set the name of the output field that will contain a version identifer for the dictionary used to apply triggers.
  - getTriggerNameField
```
public String getTriggerNameField()
```
    Get the name of the output field for storing the names of matching triggers.
    If this is the empty string, matching trigger names will not be output.
  - setTriggerNameField
```
public void setTriggerNameField(String value)
```
    Set the name of the output field for storing the names of matching triggers.
    If this is the empty string, matching trigger names will not be output.
  - getTriggerScoreField
```
public String getTriggerScoreField()
```
    Get the name of the output field for storing aggregate score for all matching triggers.
    If this is the empty string, the aggregate trigger score will not be output.
  - setTriggerScoreField
```
public void setTriggerScoreField(String value)
```
    Set the name of the output field for storing aggregate score for all matching triggers.
    If this is the empty string, the aggregate trigger score will not be output.
  - getEntityNameField
```
public String getEntityNameField()
```
    Get the name of the output field for storing the entity names for matching triggers.
    If this is the empty string, matching entity names will not be output.
  - setEntityNameField
```
public void setEntityNameField(String value)
```
    Set the name of the output field for storing the entity names for matching triggers.
    If this is the empty string, matching entity names will not be output.
  - getEntityScoreField
```
public String getEntityScoreField()
```
    Get the name of the output field for storing the per-entity scores for matching triggers.
    If this is the empty string, per-entity scores will not be output.
    
    NOTE: This field must be a dynamic field (start with *).
  - setEntityScoreField
```
public void setEntityScoreField(String value)
```
    Set the name of the output field for storing the per-entity scores for matching triggers.
    If this is the empty string, per-entity scores will not be output.
    
    NOTE: This field must be a dynamic field (start with *).
  - isTriggerNameScopes
```
public boolean isTriggerNameScopes()
```
    If true scopes will be added for trigger names for matching triggers.
  - setTriggerNameScopes
```
public void setTriggerNameScopes(boolean value)
```
    If true scopes will be added for trigger names for matching triggers.
  - isEntityNameScopes
```
public boolean isEntityNameScopes()
```
    If true scopes will be added for entity names for matching triggers.
  - setEntityNameScopes
```
public void setEntityNameScopes(boolean value)
```
    If true scopes will be added for entity names for matching triggers.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object
  - clone
```
public TriggerDictionaryInfo clone()
```
    Overrides:
    
    clone in class Object

Class TriggerDictionaryInfo

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_TRIGGER_NAME_FIELD

DEFAULT_TRIGGER_SCORE_FIELD

DEFAULT_ENTITY_NAME_FIELD

DEFAULT_TRIGGER_VERSION_FIELD

DEFAULT_ENTITY_SCORE_FIELD

DEFAULT_TRIGGER_NAME_SCOPES

DEFAULT_ENTITY_NAME_SCOPES

Constructor Detail

TriggerDictionaryInfo

TriggerDictionaryInfo

Method Detail

getName

setName

getSchemaName

setSchemaName

getSynonymDictionary

setSynonymDictionary

isCompiled

setCompiled

isPublished

setPublished

getTriggerVersionField

setTriggerVersionField

getTriggerNameField

setTriggerNameField

getTriggerScoreField

setTriggerScoreField

getEntityNameField

setEntityNameField

getEntityScoreField

setEntityScoreField

isTriggerNameScopes

setTriggerNameScopes

isEntityNameScopes

setEntityNameScopes

toString

hashCode

equals

clone