com.sap.ip.me.api.persist.meta
Interface ClassDescriptor


public interface ClassDescriptor

This class describes the meta data of a class, which can be persisted.

It contains information like class name and information of all attributes and links.

This information is used by persistence layer to store and restore the data in a proper way and to create the structure of the associated database tables

Author:
SAP
See Also:
DescriptorRuntime, AttributeDescriptor, LinkDescriptor

Method Summary
 AttributeDescriptor getAttributeDescriptor(int no)
          Returns the AttributeDescriptor for the given position.
 AttributeDescriptor[] getAttributeDescriptorArray()
          Returns all AttributeDescriptors of this ClassDescriptor
 MeIterator getAttributeDescriptors()
          Returns all AttributeDescriptors of this ClassDescriptor
 int getAttributePosition(java.lang.String name)
          Returns the position of an attribute in the ClassDescriptor.
 java.lang.String getClasstype()
          Returns the classtype (unique key) of the ClassDescriptor.
 AttributeDescriptor getKeyAttributeDescriptor()
          Returns the key AttributeDescriptor
 LinkDescriptor getLinkDescriptor(int no)
          Returns the LinkDescriptor for the given position.
 LinkDescriptor[] getLinkDescriptorArray()
          Returns all LinkDescriptors of this ClassDescriptor
 MeIterator getLinkDescriptors()
          Returns all LinkDescriptors of this ClassDescriptor
 int getLinkPosition(java.lang.String name)
          Returns the position of a link in the ClassDescriptor.
 int getPosition(AttributeDescriptor descriptor)
          Returns the position of an attribute in the ClassDescriptor.
 int getPosition(LinkDescriptor descriptor)
          Returns the position of a link in the ClassDescriptor.
 int getSecondaryIdxCount()
           
 

Method Detail

getAttributeDescriptors

public MeIterator getAttributeDescriptors()
Returns all AttributeDescriptors of this ClassDescriptor

Returns:
MeIterator containing all AttributeDescriptors

getLinkDescriptors

public MeIterator getLinkDescriptors()
Returns all LinkDescriptors of this ClassDescriptor

Returns:
MeIterator containing all LinkDescriptors

getAttributeDescriptor

public AttributeDescriptor getAttributeDescriptor(int no)
Returns the AttributeDescriptor for the given position. Simply accesses the array which was delivered on ClassDescriptor creation.

Parameters:
no - position of the AttributeDescriptor in the array
Returns:
AttributeDescriptor instance

getLinkDescriptor

public LinkDescriptor getLinkDescriptor(int no)
Returns the LinkDescriptor for the given position. Simply accesses the array which was delivered on ClassDescriptor creation.

Parameters:
no - position of the LinkDescriptor in the array
Returns:
LinkDescriptor instance

getAttributePosition

public int getAttributePosition(java.lang.String name)
Returns the position of an attribute in the ClassDescriptor.

Parameters:
name - name of the AttributeDescritor
Returns:
index of the AttributeDescritor

getLinkPosition

public int getLinkPosition(java.lang.String name)
Returns the position of a link in the ClassDescriptor.

Parameters:
name - name of the LinkDescritor
Returns:
index of the LinkDescritor

getPosition

public int getPosition(AttributeDescriptor descriptor)
Returns the position of an attribute in the ClassDescriptor.

Parameters:
descriptor - descriptor instance
Returns:
index of the AttributeDescritor

getPosition

public int getPosition(LinkDescriptor descriptor)
Returns the position of a link in the ClassDescriptor.

Parameters:
descriptor - descriptor instance
Returns:
index of the LinkDescritor

getClasstype

public java.lang.String getClasstype()
Returns the classtype (unique key) of the ClassDescriptor.

Returns:
The classtype as String

getAttributeDescriptorArray

public AttributeDescriptor[] getAttributeDescriptorArray()
Returns all AttributeDescriptors of this ClassDescriptor

Returns:
The attributeDescriptors array

getLinkDescriptorArray

public LinkDescriptor[] getLinkDescriptorArray()
Returns all LinkDescriptors of this ClassDescriptor

Returns:
The linkDescriptors array

getKeyAttributeDescriptor

public AttributeDescriptor getKeyAttributeDescriptor()
Returns the key AttributeDescriptor

Returns:
instance of the key AttributeDescriptor

getSecondaryIdxCount

public int getSecondaryIdxCount()
Returns:
number of secondary indexes.


Copyright © 2005 SAP AG. All Rights Reserved.