|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.bloomberglp.blpapi.SchemaTypeDefinition
public abstract class SchemaTypeDefinition
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.
Constructor Summary | |
---|---|
SchemaTypeDefinition()
|
Method Summary | |
---|---|
abstract ConstraintsList |
constraints()
|
abstract Schema.Datatype |
datatype()
Return the Schema.Datatype of this SchemaTypeDefinition |
abstract java.lang.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(java.lang.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(java.lang.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 java.lang.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 |
---|
public SchemaTypeDefinition()
Method Detail |
---|
public abstract void setUserData(java.lang.Object userData)
public abstract Name name()
public abstract java.lang.String description()
public abstract Schema.Status status()
public abstract Schema.Datatype datatype()
Schema.Datatype
of this SchemaTypeDefinition
public abstract boolean isComplexType()
public abstract boolean isSimpleType()
public abstract boolean isEnumerationType()
public abstract ConstantsList enumeration()
ConstantsList
of all the enumerators for this
SchemaTypeDefinition if this type is an Enumeration type.
public abstract ConstraintsList constraints()
public abstract java.lang.Object userData()
public abstract boolean hasElementDefinition(Name name)
public abstract SchemaElementDefinition getElementDefinition(Name name)
NotFoundException
- if this SchemaTypeDefinition contains
no ElementDefinition with the specified namepublic abstract SchemaElementDefinition getElementDefinition(java.lang.String name)
NotFoundException
- if this SchemaTypeDefinition contains
no ElementDefinition with the specified namepublic abstract int numElementDefinitions()
public abstract SchemaElementDefinition getElementDefinition(int index)
java.lang.IndexOutOfBoundsException
- if index >=
numElementDefinitions()
.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |