Package com.microstrategy.web.transform

Interface BeanDefns

All Superinterfaces:

java.lang.Cloneable, ConfigurationElement

All Known Implementing Classes:

BeanDefnsImpl

public interface BeanDefns
extends ConfigurationElement

The BeanDefns interface is used to manage a collection of bean definition objects.

Since:

MicroStrategy Web 7.3.1 or earlier

Method Summary

Modifier and Type	Method	Description
void	clear()	Removes all of the BeanDefn objects from the collection
BeanDefn	getBeanDefn(int index)	Retrieves a specific BeanDefn object by its numeric index.
BeanDefn	getBeanDefn(java.lang.String name)	Retrives a specific BeanDefn object by its name.
BeanDefn	getBeanDefnByClass(java.lang.String className)	Retrives a specific BeanDefn object by its class name.
int	getCount()	Returns the number of BeanDefn objects in the collection.
BeanDefn	newBeanDefn(java.lang.String beanName, java.lang.String className)	Creates a new BeanDefn object and adds it to the collection.
void	remove(int index)	Removes the BeanDefn object at the specified position in the collection.
void	remove(java.lang.String name)	Removes the BeanDefn object with the specified name from the collection.

Methods inherited from interface com.microstrategy.utils.config.ConfigurationElement

getAttribute, getAttributes, getElement, getElements, getKey, getNodeName, getStrAttribute, initFromXML, reload, toXML

Method Detail

getCount

int getCount()

Returns the number of BeanDefn objects in the collection.

Returns:

number of BeanDefn objects contained in the collection.

See Also:

BeanDefn

getBeanDefn

BeanDefn getBeanDefn(int index)
              throws java.lang.IndexOutOfBoundsException

Retrieves a specific BeanDefn object by its numeric index.

Parameters:

index - the index of the BeanDefn object in collection.

Returns:

the BeanDefn object in the collection with the given index.

Throws:

java.lang.IndexOutOfBoundsException - thrown if the index is invalid.

getBeanDefn

BeanDefn getBeanDefn(java.lang.String name)
              throws java.lang.IllegalArgumentException

Retrives a specific BeanDefn object by its name.

Parameters:

name - the name of the BeanDefn object.

Returns:

the BeanDefn object in the collection with the given name.

Throws:

java.lang.IllegalArgumentException - thrown if no bean definition has the given name in the collection.

getBeanDefnByClass

BeanDefn getBeanDefnByClass(java.lang.String className)
                     throws java.lang.IllegalArgumentException

Retrives a specific BeanDefn object by its class name.

Parameters:

className - the bean class name.

Returns:

the BeanDefn object in the collection with the given class name.

Throws:

java.lang.IllegalArgumentException - thrown if no bean definition has the given name in the collection.

clear

void clear()
    throws java.lang.UnsupportedOperationException

Removes all of the BeanDefn objects from the collection

Throws:

java.lang.UnsupportedOperationException - thrown if the collection is read-only.

remove

void remove(int index)
     throws java.lang.IndexOutOfBoundsException,
            java.lang.UnsupportedOperationException

Removes the BeanDefn object at the specified position in the collection. This method will not remove the associations made to the object deleted in a Style object.

Parameters:

index - the index of the BeanDefn object to remove.

Throws:

IndexOutOfBoundException - thrown if the specified index is out of range.

java.lang.UnsupportedOperationException - thrown if the collection is read-only.

java.lang.IndexOutOfBoundsException

remove

void remove(java.lang.String name)
     throws java.lang.IllegalArgumentException,
            java.lang.UnsupportedOperationException

Removes the BeanDefn object with the specified name from the collection. This method will not remove the associations made to the object deleted in a Style object.

Parameters:

name - the name of the BeanDefn object to remove.

Throws:

java.lang.IllegalArgumentException - thrown if no bean definition has the given name in the collection.

java.lang.UnsupportedOperationException - thrown if the collection is read-only.

newBeanDefn

BeanDefn newBeanDefn(java.lang.String beanName,
                     java.lang.String className)
              throws java.lang.IllegalArgumentException,
                     java.lang.UnsupportedOperationException

Creates a new BeanDefn object and adds it to the collection.

Parameters:

beanName - the name of the new BeanDefn object.

Returns:

the BeanDefn object just created.

Throws:

java.lang.IllegalArgumentException - thrown if the bean definition name is used by another BeanDefn object in the collection or if the style name is empty.

java.lang.UnsupportedOperationException - thrown if the collection is read-only.