- coerce(Object) - Method in interface com.sdl.context.api.types.ComparableAndCoercible
-
- coerce(Object) - Method in class com.sdl.context.api.types.GenericVersion
-
- com.sdl.context - package com.sdl.context
-
- com.sdl.context.api - package com.sdl.context.api
-
- com.sdl.context.api.definition - package com.sdl.context.api.definition
-
- com.sdl.context.api.engine - package com.sdl.context.api.engine
-
- com.sdl.context.api.exception - package com.sdl.context.api.exception
-
- com.sdl.context.api.resolution - package com.sdl.context.api.resolution
-
- com.sdl.context.api.types - package com.sdl.context.api.types
-
- com.sdl.context.internal - package com.sdl.context.internal
-
Do NOT use any class in this package as they are meant for internal use by SDL.
- COMMONS_CONFIG_FILE - Static variable in class com.sdl.context.Constants.Default
-
Default Apache commons parent configuration file name.
- ComparableAndCoercible<T> - Interface in com.sdl.context.api.types
-
Object that is comparable to other objects and coercible into other objects.
- compareTo(Version) - Method in class com.sdl.context.api.types.GenericVersion
-
- compareTo(String) - Method in class com.sdl.context.api.types.GenericVersion
-
- compareTo(VersionPart) - Method in class com.sdl.context.api.types.GenericVersionPart
-
- CONFIGURATION_ENTRY_LOCATION - Static variable in class com.sdl.context.Constants.Translation
-
The location within the configuration for translator definitions.
- Constants - Class in com.sdl.context
-
Centralisation of context constants.
- Constants.Context - Class in com.sdl.context
-
Constants for context resolution.
- Constants.Default - Class in com.sdl.context
-
Default constants.
- Constants.Evidence - Class in com.sdl.context
-
Evidence constants.
- Constants.Evidence.EvidenceName - Class in com.sdl.context
-
Evidence name constants.
- Constants.Evidence.Origin - Class in com.sdl.context
-
Various vocabulary names.
- Constants.Http - Class in com.sdl.context
-
Parameter constants.
- Constants.LevensteinDistance - Class in com.sdl.context
-
Constants for levenstein distance scan.
- Constants.Naming - Class in com.sdl.context
-
Constants relating to naming.
- Constants.Naming.Vocabulary - Class in com.sdl.context
-
Constants relating to vocabulary naming.
- Constants.Persistence - Class in com.sdl.context
-
Constants relating to persistence.
- Constants.Property - Class in com.sdl.context
-
Context Property constants.
- Constants.Translation - Class in com.sdl.context
-
Translation constants.
- containsKey(String) - Method in interface com.sdl.context.api.Aspect
-
Returns true if a property with the specified key exists in the Aspect.
- containsKey(String) - Method in interface com.sdl.context.api.ContextMap
-
Test whether the context map includes an aspect with the specified name.
- containsKey(String) - Method in interface com.sdl.context.api.resolution.Evidence
-
Returns true if the evidence contains an item with the specified key.
- containsOrigin(String) - Method in interface com.sdl.context.api.resolution.Evidence
-
Returns true if the evidence contains an evidence item of the specified origin (e.g.
- CONTEXT - Static variable in class com.sdl.context.Constants.Evidence.Origin
-
Context vocabulary name.
- CONTEXT_EVIDENCE_PRESET_TRUST - Static variable in class com.sdl.context.Constants.Context
-
Default trust for preset Context claims in evidence.
- CONTEXT_MAP_ID_MESSAGE - Static variable in class com.sdl.context.Constants.Context
-
Message fragment written to identify a context map id.
- CONTEXT_MAP_ID_MESSAGE_PATTERN - Static variable in class com.sdl.context.Constants.Context
-
Regex Pattern for the "context map id" message.
- ContextBroker - Interface in com.sdl.context.api
-
The context broker makes CWD features available to the system.
- ContextBrokerDiscoveryException - Exception in com.sdl.context.api.exception
-
Exception thrown when there was an issue with context broker discovery.
- ContextBrokerDiscoveryException(Throwable) - Constructor for exception com.sdl.context.api.exception.ContextBrokerDiscoveryException
-
- ContextBrokerDiscoveryException(String) - Constructor for exception com.sdl.context.api.exception.ContextBrokerDiscoveryException
-
- ContextBrokerRuntimeException - Exception in com.sdl.context.api.exception
-
Runtime exception to cover the rare situation where context broker jars have not
been configured correctly.
- ContextBrokerRuntimeException(String, Throwable) - Constructor for exception com.sdl.context.api.exception.ContextBrokerRuntimeException
-
- ContextEngine<A extends ContextMap<? extends Aspect>> - Interface in com.sdl.context.api.engine
-
The context engine responsible for resolving context from evidence.
- ContextMap<A extends Aspect> - Interface in com.sdl.context.api
-
A context map.
- ContextProperty - Interface in com.sdl.context.api
-
A context property.
- ContextPropertyDefinition - Interface in com.sdl.context.api.definition
-
A context property definition.
- ContextPropertyName - Interface in com.sdl.context.api.definition
-
Context property name.
- ContextPropertyType - Enum in com.sdl.context.api.definition
-
A context property type.
- ContextSegmentPath - Interface in com.sdl.context.api.types
-
A context segment path.
- ContextualDelivery - Class in com.sdl.context.api
-
Contextual Delivery static helper.
- ContextVocabulary - Interface in com.sdl.context.api
-
A vocabulary that describes context aspect and property definitions.
- COOKIE - Static variable in class com.sdl.context.Constants.Evidence.EvidenceName
-
Cookie evidence name.
- CUSTOM_CONFIG_FILE - Static variable in class com.sdl.context.Constants.Default
-
Custom config file name.
- CUSTOM_VOCABULARY_RELATIVE_URI - Static variable in class com.sdl.context.Constants.Default
-
Custom vocabulary relative name.
- CUSTOM_VOCABULARY_URI - Static variable in class com.sdl.context.Constants.Default
-
Custom vocabulary resource.
- EmptyContextBroker - Class in com.sdl.context.internal
-
Context broker that is returned when no context broker is found.
- EmptyContextBroker(ContextBrokerDiscoveryException) - Constructor for class com.sdl.context.internal.EmptyContextBroker
-
- END_BUCKET_MESSAGE - Static variable in class com.sdl.context.Constants.Context
-
Message written to the ContextMap when the EvidenceRuleBucketResolver finishes processing a bucket.
- END_BUCKET_MESSAGE_PATTERN - Static variable in class com.sdl.context.Constants.Context
-
Regex Pattern for the END_BUCKET_MESSAGE.
- END_GET_CONTEXT_MAP_MESSAGE - Static variable in class com.sdl.context.Constants.Context
-
Message written to the ContextMap when the EvidenceRuleBucketResolver loads a flattened context map.
- END_GET_CONTEXT_MAP_MESSAGE_PATTERN - Static variable in class com.sdl.context.Constants.Context
-
Regex Pattern for the END_GET_CONTEXT_MAP_MESSAGE.
- END_LEVENSTEIN_TRIE_SELECT_CONTEXT_MAP_MESSAGE - Static variable in class com.sdl.context.Constants.Context
-
Message written to the ContextMap when the TrieMatcher completes a Levenstein Distance Scan.
- END_LEVENSTEIN_TRIE_SELECT_CONTEXT_MAP_MESSAGE_PATTERN - Static variable in class com.sdl.context.Constants.Context
-
Regex Pattern for the END_LEVENSTEIN_TRIE_SELECT_CONTEXT_MAP_MESSAGE.
- END_NON_LEVENSTEIN_TRIE_SELECT_CONTEXT_MAP_MESSAGE - Static variable in class com.sdl.context.Constants.Context
-
Message written to the ContextMap when the TrieMatcher completes a Levenstein Distance Scan.
- END_NON_LEVENSTEIN_TRIE_SELECT_CONTEXT_MAP_MESSAGE_PATTERN - Static variable in class com.sdl.context.Constants.Context
-
Regex Pattern for the END_NON_LEVENSTEIN_TRIE_SELECT_CONTEXT_MAP_MESSAGE.
- equals(Object) - Method in class com.sdl.context.api.definition.GenericContextPropertyName
-
- equals(Object) - Method in class com.sdl.context.api.types.GenericVersion
-
- equals(Object) - Method in class com.sdl.context.api.types.GenericVersionPart
-
- evaluateExpression(String, ContextPropertyType) - Method in interface com.sdl.context.api.engine.ContextEngine
-
Evaluate passed expression for the specified type using evidence.
- Evidence - Interface in com.sdl.context.api.resolution
-
Evidence.
- EvidenceBuilder - Class in com.sdl.context.api.resolution
-
Evidence builder to create evidence that can be used via the ContextEngine resolve method
to resolve context.
- EvidenceBuilder() - Constructor for class com.sdl.context.api.resolution.EvidenceBuilder
-
Create new EvidenceBuilder.
- EvidenceItem - Interface in com.sdl.context.api.resolution
-
Evidence item - storage for all evidence properties.
- EXPRESSION_LENGTH - Static variable in class com.sdl.context.Constants.Persistence
-
Standard length of an expression field for persistence.
- GenericContextPropertyName - Class in com.sdl.context.api.definition
-
Generic context property name implementation.
- GenericContextPropertyName(String, String) - Constructor for class com.sdl.context.api.definition.GenericContextPropertyName
-
- GenericContextSegmentPath - Class in com.sdl.context.api.types
-
Generic context segment path.
- GenericContextSegmentPath(String, List<String>) - Constructor for class com.sdl.context.api.types.GenericContextSegmentPath
-
Create a context segment path from a list of segment names.
- GenericVersion - Class in com.sdl.context.api.types
-
Version type, e.g.
- GenericVersion() - Constructor for class com.sdl.context.api.types.GenericVersion
-
Create an instance of a version.
- GenericVersion(String) - Constructor for class com.sdl.context.api.types.GenericVersion
-
- GenericVersion(int) - Constructor for class com.sdl.context.api.types.GenericVersion
-
- GenericVersion(int, int) - Constructor for class com.sdl.context.api.types.GenericVersion
-
- GenericVersion(int, int, int) - Constructor for class com.sdl.context.api.types.GenericVersion
-
- GenericVersion(String, String) - Constructor for class com.sdl.context.api.types.GenericVersion
-
Create Version from major and minor version parts as strings.
- GenericVersion(String, String, String) - Constructor for class com.sdl.context.api.types.GenericVersion
-
- GenericVersion(double) - Constructor for class com.sdl.context.api.types.GenericVersion
-
- GenericVersionPart - Class in com.sdl.context.api.types
-
Part of a version object, e.g.
- GenericVersionPart(String) - Constructor for class com.sdl.context.api.types.GenericVersionPart
-
- GenericVersionPart(int) - Constructor for class com.sdl.context.api.types.GenericVersionPart
-
- get(String) - Method in interface com.sdl.context.api.Aspect
-
Returns the value of the property (with the specified key).
- get(String) - Method in interface com.sdl.context.api.ContextMap
-
Get aspect with the specified name, returning null if aspect does not exist.
- get(ContextPropertyName) - Method in interface com.sdl.context.api.ContextMap
-
Get context map value from context property name.
- get(String) - Method in interface com.sdl.context.api.ContextVocabulary
-
Returns the aspect definition for the specified aspect name.
- get(String) - Method in interface com.sdl.context.api.definition.AspectDefinition
-
Returns the property definition for the specified property name.
- get(String) - Method in interface com.sdl.context.api.resolution.Evidence
-
Returns the evidence item identified by the specified key (e.g.
- get(String) - Method in class com.sdl.context.api.resolution.EvidenceBuilder
-
Get the evidence value for the given key.
- getAspectName() - Method in interface com.sdl.context.api.definition.ContextPropertyDefinition
-
Name of the aspect to which this property is associated, e.g.
- getAspectName() - Method in interface com.sdl.context.api.definition.ContextPropertyName
-
Returns the name of the aspect that the property is in e.g.
- getAspectName() - Method in class com.sdl.context.api.definition.GenericContextPropertyName
-
- getAspectQualifiedName() - Method in interface com.sdl.context.api.definition.ContextPropertyName
-
Return the property name including aspect name prefix e.g.
- getAspectQualifiedName() - Method in class com.sdl.context.api.definition.GenericContextPropertyName
-
- getBroker() - Static method in class com.sdl.context.api.ContextualDelivery
-
Get the context broker for this system.
- getDefaultValue() - Method in interface com.sdl.context.api.definition.ContextPropertyDefinition
-
Returns default value.
- getDefinition() - Method in interface com.sdl.context.api.Aspect
-
Get aspect definition.
- getEngine() - Method in interface com.sdl.context.api.ContextBroker
-
Get the context engine.
- getEngine() - Method in class com.sdl.context.internal.EmptyContextBroker
-
- getExpression() - Method in interface com.sdl.context.api.definition.ContextPropertyDefinition
-
Context expression that can be used to evaluate the property value.
- getExpressionTrust() - Method in interface com.sdl.context.api.definition.ContextPropertyDefinition
-
Trust value for when expression is applied.
- getId() - Method in interface com.sdl.context.api.ContextVocabulary
-
Returns the ID (unique identifier) for the vocabulary.
- getImplies() - Method in interface com.sdl.context.api.definition.ContextPropertyDefinition
-
Segments that are automatically true when this segment is true.
- getIncrementalVersion() - Method in class com.sdl.context.api.types.GenericVersion
-
- getIncrementalVersion() - Method in interface com.sdl.context.api.types.Version
-
Returns the incremental version, e.g.
- getIncrementalVersionModifier() - Method in class com.sdl.context.api.types.GenericVersion
-
- getIncrementalVersionModifier() - Method in interface com.sdl.context.api.types.Version
-
Returns the incremental version modifier, e.g.
- getIncrementalVersionModifierNumber() - Method in class com.sdl.context.api.types.GenericVersion
-
- getIncrementalVersionModifierNumber() - Method in interface com.sdl.context.api.types.Version
-
Returns the incremental version modifier number, e.g.
- getIncrementalVersionNamePart() - Method in class com.sdl.context.api.types.GenericVersion
-
- getIncrementalVersionNamePart() - Method in interface com.sdl.context.api.types.Version
-
Returns the version part which relates to the incremental portion of the version, so
if the Version was "1.2.3" this would return a version part that relates to "3".
- getKey() - Method in interface com.sdl.context.api.resolution.EvidenceItem
-
Returns the key for the evidence item (e.g.
- getKey() - Method in interface com.sdl.context.api.types.ContextSegmentPath
-
Return the key, i.ed.
- getKey() - Method in class com.sdl.context.api.types.GenericContextSegmentPath
-
- getLocalPropertyName() - Method in interface com.sdl.context.api.definition.ContextPropertyName
-
Returns the property name e.g.
- getLocalPropertyName() - Method in class com.sdl.context.api.definition.GenericContextPropertyName
-
- getMajorVersion() - Method in class com.sdl.context.api.types.GenericVersion
-
- getMajorVersion() - Method in interface com.sdl.context.api.types.Version
-
Returns the major version, e.g.
- getMajorVersionModifier() - Method in class com.sdl.context.api.types.GenericVersion
-
- getMajorVersionModifier() - Method in interface com.sdl.context.api.types.Version
-
Returns the major version modifier, e.g.
- getMajorVersionModifierNumber() - Method in class com.sdl.context.api.types.GenericVersion
-
- getMajorVersionModifierNumber() - Method in interface com.sdl.context.api.types.Version
-
Returns the major version modifier number, e.g.
- getMajorVersionNamePart() - Method in class com.sdl.context.api.types.GenericVersion
-
- getMajorVersionNamePart() - Method in interface com.sdl.context.api.types.Version
-
Returns the version part which relates to the major portion of the version, so if
if the Version was "1.2" this would return a version part that relates to "1".
- getMap() - Method in interface com.sdl.context.api.ContextBroker
-
Get the context map for the current user interaction.
- getMap() - Method in class com.sdl.context.internal.EmptyContextBroker
-
- getMinorVersion() - Method in class com.sdl.context.api.types.GenericVersion
-
- getMinorVersion() - Method in interface com.sdl.context.api.types.Version
-
Returns the minor version, e.g.
- getMinorVersionModifier() - Method in class com.sdl.context.api.types.GenericVersion
-
- getMinorVersionModifier() - Method in interface com.sdl.context.api.types.Version
-
Returns the minor version modifier, e.g.
- getMinorVersionModifierNumber() - Method in class com.sdl.context.api.types.GenericVersion
-
- getMinorVersionModifierNumber() - Method in interface com.sdl.context.api.types.Version
-
Returns the minor version modifier number, e.g.
- getMinorVersionNamePart() - Method in class com.sdl.context.api.types.GenericVersion
-
- getMinorVersionNamePart() - Method in interface com.sdl.context.api.types.Version
-
Returns the version part which relates to the minor portion of the version, so if
if the Version was "1.2" this would return a version part that relates to "2".
- getModifier() - Method in class com.sdl.context.api.types.GenericVersionPart
-
- getModifier() - Method in interface com.sdl.context.api.types.VersionPart
-
Returns the modifier, e.g.
- getModifierNumber() - Method in class com.sdl.context.api.types.GenericVersionPart
-
- getModifierNumber() - Method in interface com.sdl.context.api.types.VersionPart
-
Returns the modifier number.
- getModifierPriority() - Method in class com.sdl.context.api.types.GenericVersionPart
-
- getModifierPriority() - Method in interface com.sdl.context.api.types.VersionPart
-
Returns a number indicating the priority of the modifier.
- getName() - Method in interface com.sdl.context.api.ContextProperty
-
Get the context property name.
- getName() - Method in interface com.sdl.context.api.definition.AspectDefinition
-
Name of the aspect e.g.
- getName() - Method in interface com.sdl.context.api.definition.ContextPropertyDefinition
-
Get the context property name for this definition.
- getName() - Method in class com.sdl.context.api.types.GenericVersion
-
- getName() - Method in interface com.sdl.context.api.types.Version
-
Returns a string representation of the version, e.g.
- getNumber() - Method in class com.sdl.context.api.types.GenericVersionPart
-
- getNumber() - Method in interface com.sdl.context.api.types.VersionPart
-
Returns the initial number of the version part, e.g.
- getOrigin() - Method in interface com.sdl.context.api.resolution.EvidenceItem
-
Returns the origin for the evidence item (e.g.
- getProperty(String) - Method in interface com.sdl.context.api.Aspect
-
Gets a property.
- getPropertyDefinitions() - Method in interface com.sdl.context.api.ContextVocabulary
-
Return all the context property definitions in this repository in order of evaluation.
- getPropertyName() - Method in interface com.sdl.context.api.definition.ContextPropertyDefinition
-
Name of the context property.
- getRequires() - Method in interface com.sdl.context.api.definition.ContextPropertyDefinition
-
Segments that are required to be true for this segment also to be true.
- getSegments() - Method in interface com.sdl.context.api.types.ContextSegmentPath
-
Returns the list of segment names in the segment path.
- getSegments() - Method in class com.sdl.context.api.types.GenericContextSegmentPath
-
- getType() - Method in interface com.sdl.context.api.definition.ContextPropertyDefinition
-
Type of the context property.
- getValue() - Method in interface com.sdl.context.api.ContextProperty
-
Gets the property value.
- getValue() - Method in interface com.sdl.context.api.resolution.EvidenceItem
-
Returns the value of the evidence item.
- getValueAsString() - Method in interface com.sdl.context.api.resolution.EvidenceItem
-
Returns a string representation of the evidence value.
- getVocabulary() - Method in interface com.sdl.context.api.ContextBroker
-
Get the context vocabulary.
- getVocabulary() - Method in interface com.sdl.context.api.engine.ContextEngine
-
Get the vocabulary being used by the engine.
- getVocabulary() - Method in class com.sdl.context.internal.EmptyContextBroker
-
- SAMPLING_INTERVAL - Static variable in class com.sdl.context.Constants.Default
-
Default sampling interval.
- SHORT_TEXT_LENGTH - Static variable in class com.sdl.context.Constants.Persistence
-
Standard length for short text for persistence.
- size() - Method in interface com.sdl.context.api.Aspect
-
Returns the number of properties in the Aspect.
- size() - Method in interface com.sdl.context.api.ContextMap
-
Get the number of aspects in this context map.
- SOURCE_BUILD_ID - Static variable in class com.sdl.context.Constants.Context
-
Context Source ID - used for stamping repository source with the original SCM source ID.
- START_BUCKET_MESSAGE - Static variable in class com.sdl.context.Constants.Context
-
Message written to the ContextMap when the EvidenceRuleBucketResolver starts processing a new bucket.
- START_BUCKET_MESSAGE_PATTERN - Static variable in class com.sdl.context.Constants.Context
-
Regex Pattern for the START_BUCKET_MESSAGE.
- START_GET_CONTEXT_MAP_MESSAGE - Static variable in class com.sdl.context.Constants.Context
-
Message written to the ContextMap when the EvidenceRuleBucketResolver loads a flattened context map.
- START_GET_CONTEXT_MAP_MESSAGE_PATTERN - Static variable in class com.sdl.context.Constants.Context
-
Regex Pattern for the START_GET_CONTEXT_MAP_MESSAGE.
- START_LEVENSTEIN_TRIE_SELECT_CONTEXT_MAP_MESSAGE - Static variable in class com.sdl.context.Constants.Context
-
Message written to the ContextMap when the TrieMatcher does a Levenstein Distance Scan.
- START_LEVENSTEIN_TRIE_SELECT_CONTEXT_MAP_MESSAGE_PATTERN - Static variable in class com.sdl.context.Constants.Context
-
Regex Pattern for the START_LEVENSTEIN_TRIE_SELECT_CONTEXT_MAP_MESSAGE.
- START_NON_LEVENSTEIN_TRIE_SELECT_CONTEXT_MAP_MESSAGE - Static variable in class com.sdl.context.Constants.Context
-
Message written to the ContextMap when the TrieMatcher does a Levenstein Distance Scan.
- START_NON_LEVENSTEIN_TRIE_SELECT_CONTEXT_MAP_MESSAGE_PATTERN - Static variable in class com.sdl.context.Constants.Context
-
Regex Pattern for the START_NON_LEVENSTEIN_TRIE_SELECT_CONTEXT_MAP_MESSAGE.
- SYSTEM_BUCKETS_URI - Static variable in class com.sdl.context.Constants.Default
-
Default system vocabulary file.
- SYSTEM_REPOSITORY_INITIALISATION_URI - Static variable in class com.sdl.context.Constants.Default
-
Default system vocabulary file.
- SYSTEM_VOCABULARY_URI - Static variable in class com.sdl.context.Constants.Default
-
Default system vocabulary file.