com.sdl.context.api

Interface ContextVocabulary

All Superinterfaces:

Serializable

public interface ContextVocabulary
extends Serializable

A vocabulary that describes context aspect and property definitions.

It contains aspect definitions which in turn include property definitions.

Method Summary

Modifier and Type	Method and Description
ContextPropertyDefinition	findPropertyDefinition(ContextPropertyName name) Returns the property definition for the specified property name.
ContextPropertyDefinition	findPropertyDefinition(String aspectName, String localPropertyName) Deprecated. - please use findPropertyDefinition(ContextPropertyName name)
AspectDefinition	get(String aspectName) Returns the aspect definition for the specified aspect name.
String	getId() Returns the ID (unique identifier) for the vocabulary.
List<ContextPropertyDefinition>	getPropertyDefinitions() Return all the context property definitions in this repository in order of evaluation.
Set<String>	keySet() Returns the set of aspect names in the vocabulary e.g.

Method Detail

keySet

Set<String> keySet()

Returns the set of aspect names in the vocabulary e.g. browser, device etc.

Returns:

set of aspect names

getId

String getId()

Returns the ID (unique identifier) for the vocabulary.

Returns:

vocabulary ID

get

AspectDefinition get(String aspectName)

Returns the aspect definition for the specified aspect name.

Parameters:

aspectName - aspect name

Returns:

aspect definition

findPropertyDefinition

@Deprecated
ContextPropertyDefinition findPropertyDefinition(String aspectName,
                                                              String localPropertyName)
                                                       throws VocabularyException

Deprecated. - please use findPropertyDefinition(ContextPropertyName name)

Returns the property definition for the specified aspect and property name.

Parameters:

aspectName - aspect name

localPropertyName - local property name

Returns:

property definition

Throws:

VocabularyException

findPropertyDefinition

ContextPropertyDefinition findPropertyDefinition(ContextPropertyName name)
                                          throws VocabularyException

Returns the property definition for the specified property name.

Parameters:

name - context property name

Returns:

property definition

Throws:

VocabularyException

getPropertyDefinitions

List<ContextPropertyDefinition> getPropertyDefinitions()

Return all the context property definitions in this repository in order of evaluation.

Returns:

Evaluation ordered context property definitions