Package it.uniroma2.art.semanticturkey.properties

Interface STProperties

All Known Subinterfaces:

Configuration, Settings

All Known Implementing Classes:

AbstractLabelBasedRenderingEngineConfiguration, AbstractPluginConfiguration, AbstractSparqlBasedCustomView, AdditionalFile, AdminMailSettings, AdvSingleValueView, AreaView, ClassTreeFilter, ClassTreePreferences, ClickableValueStyle, ConceptTreePreferences, ConnectedShowVocProjectSettings, ConnectedShowVocSystemSettings, ContentNegotiationSettings, CorePGSettings, CoreProjectSettings, CorePUSettings, CoreSystemSettings, CoreUserSettings, CorruptedProjectFacets, CustomService, CustomTreeSettings, CustomView, CustomViewAssociation, DatasetMetadataExporterSettings, DownloadProjectSettings, DynamicSTProperties, DynamicVectorView, ErrorReportingSettings, FromMailSettings, InstanceListPreferences, InvokableReporter, Language, LexEntryListPreferences, MailSettings, NotificationSystemSettings, NotificationSystemSettings.CronDefinition, Operation, Parameter, PointView, PredicateLabelSettings, PreloadProfilerSettings, PreloadSettings, ProjectCreationSettings, ProjectFacets, ProjectsSearchGroup, ProjectVisualization, PropertyChainView, RDFTransformerChainConfiguration, RemoteAlignmentServiceConfiguration, RemoteAlignmentServiceProjectSettings, RemoteTripleStoreSettings, RenderingEnginePUSettings, ResourceMetadataAssociation, ResourceMetadataPattern, ResourceViewCustomSectionSettings, ResourceViewPreferences, ResourceViewProjectSettings, ResViewSectionDisplayInfo, RouteView, SearchSettings, SepiaSettings, SeriesCollectionView, SeriesView, ServiceInvocation, SHACLSettings, Sheet2RdfSettings, ShowVocSettings, SingleDownload, SmtpMailSettings, StaticVectorView, StoredAdvancedGraphApplicationConfiguration, StoredContributionConfiguration, StoredCustomSearch, StoredDevResourceContributionConfiguration, StoredExportConfiguration, StoredImportConfiguration, StoredMetadataContributionConfiguration, StoredProjectMetadata, StoredSPARQLOperation, StoredSPARQLParameterization, StoredStableResourceContributionConfiguration, StoredTemplateConfiguration, STPropertiesImpl, STPropertiesSchema, STPropertyEnumeration, STPropertySchema, STPropertyType, Uri2ProjectResolutionSettings, ValueFilterLanguages, VariableDefinition, VocBenchConnectionShowVocSettings

public interface STProperties

Author:

Armando Stellato <stellato@uniroma2.it>, Manuel Fiorelli <fiorelli@info.uniroma2.it>

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static @interface	STProperties.BasicPropertiesConstraints
static class	STProperties.BasicPropertyConstraintValidator

Method Summary

Modifier and Type	Method	Description
default Object	checkAndConvertPropertyValue(String id, Object value, Type propType)
default Object	convertToPropertValue(Type type, Object value)
static <T extends STProperties> void	deepMerge(T toProps, T fromProps)	Deep copy properties from fromProps into toProps.
default Annotation[]	getAnnotations(String id)	Returns the annotations (if any) associated with the property with given id.
default Optional<EnumerationDescription>	getEnumeration(String id)	Returns the enumeration (if any) associated with the property with given id.
default String	getHTMLDescription()	An optional HTML description of this type of propertySet
default String	getHTMLWarning()	An optional HTML warning related to this type of propertySet
default Collection<String>	getProperties()	returns all the properties of the class implementing this interface, which have been annotated as STProperty
default AnnotatedType	getPropertyAnnotatedType(String id)
default String	getPropertyContentType(String parID)	get the expected type of content for the property.
default String	getPropertyDescription(String id)	this method returns the description of a property
default String	getPropertyDisplayName(String id)	this method returns the displayName of a property.
default Type	getPropertyType(String id)
default Object	getPropertyValue(String id)	gets the value of a property previously set on this set of properties
String	getShortName()
default String	getStringRepresentation()
default boolean	hasRequiredProperties()	tells if this set of properties needs to be explicitly set by the user or if it can be used in its default settings
default boolean	isEnumerated(String id)	Tells if the property with given id is enumerated: either its type is an enum (see getPropertyType(String)) or it is annotated with Enumeration.
default boolean	isRequiredProperty(String parID)
default void	loadProperties(File propertyFile)	invokes setPropertyValue(String, Object) on each of the property/value pairs found in propertyFile
default void	setProperties(Properties props)	invokes setPropertyValue(String, Object) on each of the property/value pairs found in properties
default void	setPropertyValue(String id, Object value)
default void	storeProperties(File propertyFile)	stores the properties in this instance in file propertyFile
default void	storeProperties(Properties properties)	stores the properties in this instance in the given Properties object properties

Method Details

getShortName

String getShortName()

Returns:

a humanly understandable short name representing the type of this property set

getHTMLDescription

default String getHTMLDescription()

An optional HTML description of this type of propertySet

Returns:

an HTML description of this type of propertySet. It may be null, if no description is available

getHTMLWarning

default String getHTMLWarning()

An optional HTML warning related to this type of propertySet

Returns:

An optional HTML warning related to this type of propertySet. It may be null, if no warning is available

getProperties

default Collection<String> getProperties()

returns all the properties of the class implementing this interface, which have been annotated as STProperty

Returns:

getPropertyValue

default Object getPropertyValue(String id)
                         throws PropertyNotFoundException

gets the value of a property previously set on this set of properties

Parameters:

id -

Returns:

Throws:

PropertyNotFoundException

getPropertyType

default Type getPropertyType(String id)
                      throws PropertyNotFoundException

Throws:

PropertyNotFoundException

getPropertyAnnotatedType

default AnnotatedType getPropertyAnnotatedType(String id)
                                        throws PropertyNotFoundException

Throws:

PropertyNotFoundException

setPropertyValue

default void setPropertyValue(String id,
 Object value)
                       throws WrongPropertiesException

Throws:

WrongPropertiesException

checkAndConvertPropertyValue

default Object checkAndConvertPropertyValue(String id,
 Object value,
 Type propType)
                                     throws IllegalArgumentException,
PropertyNotFoundException

Throws:

IllegalArgumentException

PropertyNotFoundException

setProperties

default void setProperties(Properties props)
                    throws WrongPropertiesException

invokes setPropertyValue(String, Object) on each of the property/value pairs found in properties

Parameters:

props -

Throws:

WrongPropertiesException

loadProperties

default void loadProperties(File propertyFile)
                     throws WrongPropertiesException,
IOException

invokes setPropertyValue(String, Object) on each of the property/value pairs found in propertyFile

Parameters:

propertyFile -

Throws:

WrongPropertiesException

IOException

storeProperties

default void storeProperties(File propertyFile)
                      throws IOException,
WrongPropertiesException

stores the properties in this instance in file propertyFile

Parameters:

propertyFile -

Throws:

IOException

WrongPropertiesException

storeProperties

default void storeProperties(Properties properties)
                      throws IOException,
WrongPropertiesException

stores the properties in this instance in the given Properties object properties

Parameters:

properties -

Throws:

IOException

WrongPropertiesException

getPropertyContentType

default String getPropertyContentType(String parID)
                               throws PropertyNotFoundException

get the expected type of content for the property. Can be used by external tools to drive the acquisition of that value or to check

Parameters:

parID -

Returns:

Throws:

PropertyNotFoundException

isRequiredProperty

default boolean isRequiredProperty(String parID)
                            throws PropertyNotFoundException

Throws:

PropertyNotFoundException

hasRequiredProperties

default boolean hasRequiredProperties()

tells if this set of properties needs to be explicitly set by the user or if it can be used in its default settings

Returns:

getPropertyDescription

default String getPropertyDescription(String id)
                               throws PropertyNotFoundException

this method returns the description of a property

Parameters:

id -

Returns:

Throws:

PropertyNotFoundException

getPropertyDisplayName

default String getPropertyDisplayName(String id)
                               throws PropertyNotFoundException

this method returns the displayName of a property. If not provided, return the property name

Parameters:

id -

Returns:

Throws:

PropertyNotFoundException

convertToPropertValue

default Object convertToPropertValue(Type type,
 Object value)

getStringRepresentation

default String getStringRepresentation()

isEnumerated

default boolean isEnumerated(String id)
                      throws PropertyNotFoundException

Tells if the property with given id is enumerated: either its type is an enum (see getPropertyType(String)) or it is annotated with Enumeration.

Parameters:

id -

Returns:

Throws:

PropertyNotFoundException

getEnumeration

default Optional<EnumerationDescription> getEnumeration(String id)
                                                 throws PropertyNotFoundException

Returns the enumeration (if any) associated with the property with given id.

Parameters:

id -

Returns:

Throws:

PropertyNotFoundException

getAnnotations

default Annotation[] getAnnotations(String id)
                             throws PropertyNotFoundException

Returns the annotations (if any) associated with the property with given id.

Parameters:

id -

Returns:

Throws:

PropertyNotFoundException

deepMerge

static <T extends STProperties> void deepMerge(T toProps,
 T fromProps)

Deep copy properties from fromProps into toProps. Merge is performed in place in the argument toProps, possibly sharing resources from the argument fromProps.

Type Parameters:

T -

Parameters:

toProps -

fromProps -