com.bloomberglp.blpapi

Class SchemaTypeDefinition

java.lang.Object

com.bloomberglp.blpapi.SchemaTypeDefinition

public abstract class SchemaTypeDefinition
extends Object

The definition of a type in the schema.

Each SchemaElementDefinition object has a SchemaTypeDefinition (which it may share with other SchemaElementDefinition objects). SchemaTypeDefinition objects are read-only and always created by the API, never by the application.

A SchemaTypeDefinition can define items which are either simple (that is, they are a single value) or a sequence or a choice Element (that is, they may contain an item or items which are accessed by name)

For sequence or choice items the SchemaTypeDefinition provides access to the individual SchemaElementDefinition objects that define each member of the sequence.

In addition, the SchemaTypeDefinition provides access to the symbolic name of the TypeDefinition, its description and its status.

Author:

Chao Yao(cyao3)

Constructor Summary

Constructors

Constructor and Description
SchemaTypeDefinition()

Method Summary

Modifier and Type	Method and Description
abstract ConstraintsList	constraints()
abstract Schema.Datatype	datatype() Return the Schema.Datatype of this SchemaTypeDefinition
abstract String	description() Return a string which contains a human readable description of this SchemaTypeDefinition
abstract ConstantsList	enumeration() Return a ConstantsList of all the enumerators for this SchemaTypeDefinition if this type is an Enumeration type.
abstract SchemaElementDefinition	getElementDefinition(int index) Return the ElementDefinition at the specified index in this SchemaTypeDefinition
abstract SchemaElementDefinition	getElementDefinition(Name name) Return the ElementDefinition with the specified name in this SchemaTypeDefinition
abstract SchemaElementDefinition	getElementDefinition(String name) Return the ElementDefinition with the specified name in this SchemaTypeDefinition
abstract boolean	hasElementDefinition(Name name) Return true if this SchemaTypeDefinition contains an ElementDefinition with the specified name.
abstract boolean	isComplexType() Return true if this SchemaTypeDefinition defines a Sequence or a Choice type.
abstract boolean	isEnumerationType() Return true if this SchemaTypeDefinition defines a enumerated type
abstract boolean	isSimpleType() Return true if this SchemaTypeDefinition defines a primitive type
abstract Name	name() Return the name of this SchemaTypeDefinition
abstract int	numElementDefinitions() Return the number of ElementDefinitions in this SchemaTypeDefinition
abstract void	setUserData(Object userData) Set the user data associated with this SchemaTypeDefinition to the specified userData.
abstract Schema.Status	status() Return the status of this SchemaTypeDefinition
abstract Object	userData() Return the user data associated with this SchemaTypeDefinition

Methods inherited from class java.lang.Object

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

Constructor Detail

SchemaTypeDefinition

public SchemaTypeDefinition()

Method Detail

setUserData

public abstract void setUserData(Object userData)

Set the user data associated with this SchemaTypeDefinition to the specified userData.

name

public abstract Name name()

Return the name of this SchemaTypeDefinition

description

public abstract String description()

Return a string which contains a human readable description of this SchemaTypeDefinition

status

public abstract Schema.Status status()

Return the status of this SchemaTypeDefinition

datatype

public abstract Schema.Datatype datatype()

Return the Schema.Datatype of this SchemaTypeDefinition

isComplexType

public abstract boolean isComplexType()

Return true if this SchemaTypeDefinition defines a Sequence or a Choice type.

isSimpleType

public abstract boolean isSimpleType()

Return true if this SchemaTypeDefinition defines a primitive type

isEnumerationType

public abstract boolean isEnumerationType()

Return true if this SchemaTypeDefinition defines a enumerated type

enumeration

public abstract ConstantsList enumeration()

Return a ConstantsList of all the enumerators for this SchemaTypeDefinition if this type is an Enumeration type.

constraints

public abstract ConstraintsList constraints()

userData

public abstract Object userData()

Return the user data associated with this SchemaTypeDefinition

hasElementDefinition

public abstract boolean hasElementDefinition(Name name)

Return true if this SchemaTypeDefinition contains an ElementDefinition with the specified name.

getElementDefinition

public abstract SchemaElementDefinition getElementDefinition(Name name)

Return the ElementDefinition with the specified name in this SchemaTypeDefinition

Throws:

NotFoundException - if this SchemaTypeDefinition contains no ElementDefinition with the specified name

getElementDefinition

public abstract SchemaElementDefinition getElementDefinition(String name)

Return the ElementDefinition with the specified name in this SchemaTypeDefinition

Throws:

NotFoundException - if this SchemaTypeDefinition contains no ElementDefinition with the specified name

numElementDefinitions

public abstract int numElementDefinitions()

Return the number of ElementDefinitions in this SchemaTypeDefinition

getElementDefinition

public abstract SchemaElementDefinition getElementDefinition(int index)

Return the ElementDefinition at the specified index in this SchemaTypeDefinition

Throws:

IndexOutOfBoundsException - if index >= numElementDefinitions().