org.apache.ambari.server.controller.spi

Interface Schema

All Known Implementing Classes:

SchemaImpl

public interface Schema

The schema is used to describe all of the properties that a resource type supports.

Method Summary

Modifier and Type	Method and Description
String	getKeyPropertyId(Resource.Type type) Get the property id for the property that uniquely identifies the given resource type for the resource described by this schema.
Set<Resource.Type>	getKeyTypes() Get the set of resource types used in the key that uniquely identifies the resource type described by this schema.

Method Detail

getKeyPropertyId

String getKeyPropertyId(Resource.Type type)

Get the property id for the property that uniquely identifies the given resource type for the resource described by this schema.

For example, the resource 'HostComponent' is uniquely identified by its associated 'Cluster', 'Host' and 'Component' resources. Passing the 'Host' resource type to this method on a schema object of a 'HostComponent' resource will return the id of the property of the foreign key reference from the 'HostComponent' to the 'Host'.

Parameters:

type - the resource type

Returns:

the key property id for the given resource type

getKeyTypes

Set<Resource.Type> getKeyTypes()

Get the set of resource types used in the key that uniquely identifies the resource type described by this schema.

For example, the resource 'HostComponent' is uniquely identified by its associated 'Cluster', 'Host' and 'Component' resources. Calling this method should return a set of those resource types.

Returns:

the set of resource types used in the key that uniquely identifies the resource type described by this schema.