Package org.apache.jena.sparql.util
Class Context
- java.lang.Object
-
- org.apache.jena.sparql.util.Context
-
- Direct Known Subclasses:
JsonLDReadContext
,JsonLDWriteContext
public class Context extends java.lang.Object
A class for setting and keeping named values. Used to pass implementation-specific parameters across general interfaces.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clear()
Context
copy()
Return a copy of this context.static Context
create()
Create an empty contextstatic Context
emptyContext()
Empty, immutable contextboolean
equals(java.lang.Object obj)
static Context
fromDataset(DatasetGraph dataset)
Return the context of the dataset (not copied); if the dataset is null, return null<T> T
get(Symbol property)
Get the object value of a property or null<T> T
get(Symbol property, T defaultValue)
Get the object value of a property - return the default value if not present .java.lang.String
getAsString(Symbol property)
Get the value a string (uses .toString() if the value is not null)java.lang.String
getAsString(Symbol property, java.lang.String defaultValue)
Get the value a string (uses .toString() if the value is not null) - supply a default string valueint
getInt(Symbol symbol, int defaultValue)
Get the value as a long value.long
getLong(Symbol symbol, long defaultValue)
Get the value as a long value.int
hashCode()
boolean
hasValue(Symbol property, java.lang.Object value)
Test whether a named value is a specific value (.equals)boolean
hasValueAsString(Symbol property, java.lang.String value)
Test whether a named value (as a string) has a specific string formboolean
hasValueAsString(Symbol property, java.lang.String value, boolean ignoreCase)
Test whether a named value (as a string) has a specific string form - can ignore caseboolean
isDefined(Symbol property)
Is a property set?boolean
isFalse(Symbol property)
Is the value 'false' (either set to the string "false" or Boolean.FALSE)boolean
isFalseOrUndef(Symbol property)
Is the value 'false' (either set to the string "false" or Boolean.FALSE) or undefinedboolean
isTrue(Symbol property)
Is the value 'true' (either set to the string "true" or Boolean.TRUE)boolean
isTrueOrUndef(Symbol property)
Is the value 'true' (either set to the string "true" or Boolean.TRUE) or undefined?boolean
isUndef(Symbol property)
Is a property not set?java.util.Set<Symbol>
keys()
Set of properties (as Symbols) currently definedstatic Context
mergeCopy(Context contextGlobal, Context contextLocal)
Merge an outer (defaults to the system global context) and local context to produce a new context The new context is always a separate copy.void
put(Symbol property, java.lang.Object value)
Store a named value - overwrites any previous set valuevoid
putAll(Context other)
void
remove(Symbol property)
Remove any value associated with a propertyContext
set(Symbol property, boolean value)
Store a named value - overwrites any previous set value.Context
set(Symbol property, java.lang.Object value)
Store a named value - overwrites any previous set value.static void
setCurrentDateTime(Context context)
Context
setFalse(Symbol property)
Set property value to be false.Context
setIfUndef(Symbol property, java.lang.Object value)
Store a named value only if it is not currently set.Context
setTrue(Symbol property)
Set property value to be true.static Context
setupContextForDataset(Context globalContext, DatasetGraph dataset)
Setup a context using another context and a dataset.int
size()
Return the number of context itemsjava.lang.String
toString()
void
unset(Symbol property)
Remove any value associated with a property - alternative method name
-
-
-
Constructor Detail
-
Context
public Context()
Create an empty context
-
Context
public Context(Context cxt)
Create a context and initialize it with a copy of the named values of another one. Shallow copy: the values themselves are not copied
-
-
Method Detail
-
emptyContext
public static final Context emptyContext()
Empty, immutable context
-
create
public static Context create()
Create an empty context
-
copy
public Context copy()
Return a copy of this context. Modifications of the copy do not affect the original context.
-
get
public <T> T get(Symbol property)
Get the object value of a property or null
-
get
public <T> T get(Symbol property, T defaultValue)
Get the object value of a property - return the default value if not present .
-
put
public void put(Symbol property, java.lang.Object value)
Store a named value - overwrites any previous set value
-
set
public Context set(Symbol property, java.lang.Object value)
Store a named value - overwrites any previous set value. Returns "this".
-
set
public Context set(Symbol property, boolean value)
Store a named value - overwrites any previous set value. Returns "this".
-
setIfUndef
public Context setIfUndef(Symbol property, java.lang.Object value)
Store a named value only if it is not currently set. Returns "this".
-
putAll
public void putAll(Context other)
-
remove
public void remove(Symbol property)
Remove any value associated with a property
-
unset
public void unset(Symbol property)
Remove any value associated with a property - alternative method name
-
isDefined
public boolean isDefined(Symbol property)
Is a property set?
-
isUndef
public boolean isUndef(Symbol property)
Is a property not set?
-
getAsString
public java.lang.String getAsString(Symbol property, java.lang.String defaultValue)
Get the value a string (uses .toString() if the value is not null) - supply a default string value
-
getAsString
public java.lang.String getAsString(Symbol property)
Get the value a string (uses .toString() if the value is not null)
-
getInt
public int getInt(Symbol symbol, int defaultValue)
Get the value as a long value. The context entry can be a string, Integer or Long.
-
getLong
public long getLong(Symbol symbol, long defaultValue)
Get the value as a long value. The context entry can be a string, Integer or Long.
-
isTrue
public boolean isTrue(Symbol property)
Is the value 'true' (either set to the string "true" or Boolean.TRUE)
-
isTrueOrUndef
public boolean isTrueOrUndef(Symbol property)
Is the value 'true' (either set to the string "true" or Boolean.TRUE) or undefined?
-
isFalse
public boolean isFalse(Symbol property)
Is the value 'false' (either set to the string "false" or Boolean.FALSE)
-
isFalseOrUndef
public boolean isFalseOrUndef(Symbol property)
Is the value 'false' (either set to the string "false" or Boolean.FALSE) or undefined
-
hasValue
public boolean hasValue(Symbol property, java.lang.Object value)
Test whether a named value is a specific value (.equals)
-
hasValueAsString
public boolean hasValueAsString(Symbol property, java.lang.String value)
Test whether a named value (as a string) has a specific string form
-
hasValueAsString
public boolean hasValueAsString(Symbol property, java.lang.String value, boolean ignoreCase)
Test whether a named value (as a string) has a specific string form - can ignore case
-
keys
public java.util.Set<Symbol> keys()
Set of properties (as Symbols) currently defined
-
size
public int size()
Return the number of context items
-
clear
public void clear()
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
fromDataset
public static Context fromDataset(DatasetGraph dataset)
Return the context of the dataset (not copied); if the dataset is null, return null
-
setupContextForDataset
public static Context setupContextForDataset(Context globalContext, DatasetGraph dataset)
Setup a context using another context and a dataset.
-
setCurrentDateTime
public static void setCurrentDateTime(Context context)
-
mergeCopy
public static Context mergeCopy(Context contextGlobal, Context contextLocal)
Merge an outer (defaults to the system global context) and local context to produce a new context The new context is always a separate copy.
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
-