public abstract class MetaProperty<T> extends Object
Representation of a Stardog metadata property. Meta properties provide information about Stardog system and databases
in Stardog. Some meta properties (e.g. IndexOptions.INDEX_TYPE
) are used to configure various
aspects of Stardog behavior for loading, indexing, querying, and so on. Other properties only provide information and
cannot be modified by users (e.g. IndexOptions.DIFF_INDEX_SIZE
). See the implementations of
MetaPropertyProvider
interface for a complete list of met properties supported by Stardog.
A meta property is uniquely identified by its name
. Properties may have a predefined
default value
that will be used if there is no user-specified value. The values for meta
properties are stored in Metadata
.
There are two distinct kinds of meta properties: configuration property
and
information property
. The values for either property kind can be retrieved using
com.complexible.stardog.api.admin.AdminConnection#get(String, MetaProperty)
function but only if the property is readable
(some meta properties are for system use only and their value cannot be read by users). The values for config
properties can be specified as input to the database builder at database creation time using its
com.complexible.stardog.api.admin.DatabaseBuilder#set(ConfigProperty, Object)
function if the property is creatable
. The values for config properties can be modified later through the AdminConnection
interface with
the com.complexible.stardog.api.admin.AdminConnection#set(String, ConfigProperty, Object)
function if the property is
writable
.
Metadata
Modifier and Type | Class and Description |
---|---|
static class |
MetaProperty.Builder<T,P extends MetaProperty<T>>
The builder class for building an option instance.
|
protected static class |
MetaProperty.Flag |
Modifier | Constructor and Description |
---|---|
protected |
MetaProperty(String theName) |
Modifier and Type | Method and Description |
---|---|
static <T> MetaProperty.Builder<T,ConfigProperty<T>> |
config(String theName,
Class<T> theClass) |
static <T> MetaProperty.Builder<Collection<T>,ConfigProperty<Collection<T>>> |
config(String theName,
Class<T> theClass,
Collection<T> theDefaultValue) |
static <T> MetaProperty.Builder<T,ConfigProperty<T>> |
config(String theName,
Class<T> theClass,
T theDefaultValue) |
static <T> MetaProperty.Builder<T,ConfigProperty<T>> |
config(String theName,
T theDefaultValue) |
boolean |
equals(Object other) |
com.complexible.stardog.metadata.ByteIO<T> |
getByteIO() |
String |
getCategory() |
com.complexible.stardog.metadata.MetaProperty.CollectionType |
getCollectionType() |
T |
getDefaultValue() |
String |
getDescription() |
com.complexible.stardog.metadata.GraphIO<T> |
getGraphIO() |
String |
getLabel() |
String |
getName() |
String |
getPermission()
Return the name of the Database metadata security permission that a user is required to have in order to
set the value of this property.
|
Collection<T> |
getPossibleValues() |
T |
getSystemDefaultValue() |
com.complexible.stardog.metadata.TextIO<T> |
getTextIO() |
Class<?> |
getType() |
int |
hashCode() |
static <T> MetaProperty.Builder<T,InfoProperty<T>> |
info(String theName,
Class<T> theClass) |
static <T> MetaProperty.Builder<Collection<T>,InfoProperty<Collection<T>>> |
info(String theName,
Class<T> theClass,
Collection<T> theDefaultValue) |
static <T> MetaProperty.Builder<T,InfoProperty<T>> |
info(String theName,
T theDefaultValue) |
boolean |
isConfig() |
boolean |
isDatabase() |
boolean |
isDiskIndex() |
boolean |
isIndex() |
boolean |
isInfo() |
boolean |
isMemoryIndex() |
boolean |
isReadable() |
boolean |
isSecure()
Returns
true if retrieving the value of this property requires database metadata read permission. |
boolean |
isServer() |
boolean |
isTemporary() |
boolean |
isValid(T theValue) |
boolean |
isWritableOnline() |
protected void |
setByteIO(com.complexible.stardog.metadata.ByteIO<T> theByteIO) |
void |
setCategory(String theCategory) |
void |
setDescription(String theDescription) |
protected void |
setGraphIO(com.complexible.stardog.metadata.GraphIO<T> theGraphIO) |
void |
setLabel(String theLabel) |
void |
setTextIO(com.complexible.stardog.metadata.TextIO<T> theTextIO) |
protected void |
setType(Class<?> theType) |
String |
toString() |
protected MetaProperty(String theName)
public String getPermission()
isSecure()
should return true for the value of this method to
be relevant.public String getName()
public void setLabel(String theLabel)
public String getLabel()
public void setDescription(String theDescription)
public String getDescription()
public String getCategory()
public void setCategory(String theCategory)
protected void setType(Class<?> theType)
public Class<?> getType()
public com.complexible.stardog.metadata.MetaProperty.CollectionType getCollectionType()
public T getDefaultValue()
public Collection<T> getPossibleValues()
public T getSystemDefaultValue()
public boolean isConfig()
public boolean isInfo()
public boolean isSecure()
true
if retrieving the value of this property requires database metadata read permission. Some
database metadata properties, e.g. namespaces, can be read without metadata permissions. Databases read/write
permissions will still be required to read the value of this property if this function returns false
.public boolean isTemporary()
public boolean isDatabase()
public boolean isDiskIndex()
public boolean isMemoryIndex()
public boolean isIndex()
public boolean isReadable()
public boolean isServer()
public boolean isWritableOnline()
public com.complexible.stardog.metadata.ByteIO<T> getByteIO()
protected void setByteIO(com.complexible.stardog.metadata.ByteIO<T> theByteIO)
public com.complexible.stardog.metadata.TextIO<T> getTextIO()
public void setTextIO(com.complexible.stardog.metadata.TextIO<T> theTextIO)
public com.complexible.stardog.metadata.GraphIO<T> getGraphIO()
protected void setGraphIO(com.complexible.stardog.metadata.GraphIO<T> theGraphIO)
public boolean isValid(T theValue)
public static <T> MetaProperty.Builder<T,ConfigProperty<T>> config(String theName, T theDefaultValue)
public static <T> MetaProperty.Builder<T,ConfigProperty<T>> config(String theName, Class<T> theClass)
public static <T> MetaProperty.Builder<T,ConfigProperty<T>> config(String theName, Class<T> theClass, T theDefaultValue)
public static <T> MetaProperty.Builder<Collection<T>,ConfigProperty<Collection<T>>> config(String theName, Class<T> theClass, Collection<T> theDefaultValue)
public static <T> MetaProperty.Builder<T,InfoProperty<T>> info(String theName, T theDefaultValue)
public static <T> MetaProperty.Builder<T,InfoProperty<T>> info(String theName, Class<T> theClass)
public static <T> MetaProperty.Builder<Collection<T>,InfoProperty<Collection<T>>> info(String theName, Class<T> theClass, Collection<T> theDefaultValue)
Copyright © 2010-2016 Stardog Union. All Rights Reserved.