Class ComponentInfo

java.lang.Object

tech.oxfordsemantic.jrdfox.client.ComponentInfo

public class ComponentInfo
extends Object

Encapsulates information about a component of the data store.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ComponentInfo.Property	Encapsulates an individual datapoint of information about a component of the data store.

Constructor Summary

Constructors

Constructor	Description
ComponentInfo(ComponentInfo.Property[] properties, ComponentInfo[] subComponents)

Method Summary

Modifier and Type	Method	Description
int	getNumberOfProperties()	Returns the number of properties.
int	getNumberOfSubComponents()	Returns the number of sub-components.
ComponentInfo.Property	getProperty(int index)	Returns an individual property.
ComponentInfo.Property	getProperty(ComponentInfoMetric metric, String uniqueName)	Returns an individual property by its metric and unique name.
ComponentInfo	getSubComponent(int index)	Returns information about a sub-component.
ComponentInfo	getSubComponent(String name)	Returns information about a sub-component by its name.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ComponentInfo

public ComponentInfo(ComponentInfo.Property[] properties,
 ComponentInfo[] subComponents)

Method Details

getNumberOfSubComponents

public int getNumberOfSubComponents()

Returns the number of sub-components.

Returns:

the number of sub-components.

getSubComponent

public ComponentInfo getSubComponent(int index)

Returns information about a sub-component.

Parameters:

index - the zero-based index of the sub-component to access.

Returns:

the sub-component information.

getSubComponent

public ComponentInfo getSubComponent(String name)

Returns information about a sub-component by its name.

Returns:

the sub-component information, or null if no such sub-component exists.

getNumberOfProperties

public int getNumberOfProperties()

Returns the number of properties.

Returns:

the number of properties.

getProperty

public ComponentInfo.Property getProperty(int index)

Returns an individual property.

Parameters:

index - the zero-based index of the property to access.

Returns:

the property information.

getProperty

public ComponentInfo.Property getProperty(ComponentInfoMetric metric,
 String uniqueName)

Returns an individual property by its metric and unique name.

Parameters:

metric - the metric of the property to access.

uniqueName - the unique name of the property to access, or null if the property does not have a unique name.

Returns:

the property information, or null if no such property exists.