org.xquark.xml.xdbc
Interface Configurable

All Known Subinterfaces:
XMLCollection, XMLDocumentFiler

public interface Configurable

This interface provides setters and getters for metadata (features or properties) associated to an object. The set of supported features and properties depends on vendors implementation.
For some objects, some configuration data may not be changed after the object creation.
An XMLDBCNotRecognizedException or XMLDBCNotSupportedException will be thrown if an object does not support a metadata method.


Method Summary
 boolean getFeature(java.lang.String featureId)
          Get the state of a configuration feature.
 java.lang.String[] getFeatureList()
          Get the list of supported configuration features
 java.lang.Object getProperty(java.lang.String propertyId)
          Get the value of a configuration property (only properties set in this configuration).
 java.lang.String[] getPropertyList()
          Get the list of supported properties
 void setFeature(java.lang.String featureId, boolean state)
          Set the state of a configuration feature.
 void setProperty(java.lang.String propertyId, java.lang.Object value)
          Set the state of a configuration property.
 

Method Detail

setFeature

public void setFeature(java.lang.String featureId,
                       boolean state)
                throws XMLDBCNotRecognizedException,
                       XMLDBCNotSupportedException
Set the state of a configuration feature.

Parameters:
featureId - The unique identifier (URI) of the feature.
state - The requested state of the feature (true or false).
Throws:
XMLDBCNotRecognizedException - if feature does not exist for this object.
XMLDBCNotSupportedException - if state for the feature is not supported by this object.

getFeature

public boolean getFeature(java.lang.String featureId)
                   throws XMLDBCNotRecognizedException
Get the state of a configuration feature.

Parameters:
featureId - The unique identifier (URI) of the feature to get.
Returns:
the state of a configuration feature.
Throws:
XMLDBCNotRecognizedException - if feature does not exist for this object.

getFeatureList

public java.lang.String[] getFeatureList()
Get the list of supported configuration features


setProperty

public void setProperty(java.lang.String propertyId,
                        java.lang.Object value)
                 throws XMLDBCNotRecognizedException,
                        XMLDBCNotSupportedException
Set the state of a configuration property.

Parameters:
propertyId - The unique identifier (URI) of the property.
value - The requested value of the property (can be null).
Throws:
XMLDBCNotRecognizedException - if property does not exist for this driver.
XMLDBCNotSupportedException - if value for the property is not supported by this object.

getProperty

public java.lang.Object getProperty(java.lang.String propertyId)
                             throws XMLDBCNotRecognizedException
Get the value of a configuration property (only properties set in this configuration).

Parameters:
propertyId - The unique identifier (URI) of the feature to get.
Returns:
the value of the specified property (can be null).
Throws:
XMLDBCNotRecognizedException - if property does not exist for this object.

getPropertyList

public java.lang.String[] getPropertyList()
Get the list of supported properties



Copyright © 2004 Université de Versailles Saint-Quentin, XQuark Group. All rights reserved.