|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface MetadataDescriptor
MetadataDescriptor is an interface for a single metadata descriptor. It defines a lookup service for property metadata; in addition to actual metadata values, the interface has convenience methods for answering common questions ("Can I delete this property?", etc.) rather than requiring the user to calculate the answers based on metadata values. This interface is based on WS-RMD 1.0.
Method Summary | |
---|---|
void |
addProperty(QName property,
String modifiability,
String mutability)
Adds another wsrmd:Property element to the descriptor with the basic metadata attributes required by the spec. |
boolean |
canDelete(QName property)
|
boolean |
canInsert(QName property)
|
boolean |
canUpdate(QName property)
|
String |
getExtendedMetadata(QName property,
QName elementName)
This method allows you to extend a wsrmd:Property definition and provide application-specific metadata for a property. |
Collection |
getExtendedMetadataNames(QName property)
|
Collection |
getInitialValues(QName property)
|
Collection |
getInitialValues(QName property,
Class javaType)
|
QName |
getInterface()
|
String |
getLowerBound(QName property)
|
String |
getModifiability(QName property)
Most users will probably want to use the canDelete(), canInsert(), and canUpdate() methods to test the permissions of a property; these methods handle the Boolean logic between modifiability and mutability values so you don't have to litter your code with messy if/else blocks. |
String |
getMutability(QName property)
Most users will probably want to use the canDelete(), canInsert(), and canUpdate() methods to test the permissions of a property; these methods handle the Boolean logic between modifiability and mutability values so you don't have to litter your code with messy if/else blocks. |
String |
getName()
|
Collection |
getPropertyNames()
|
Collection |
getStaticValues(QName property)
|
Collection |
getStaticValues(QName property,
Class javaType)
|
String |
getUpperBound(QName property)
|
Collection |
getValidValues(QName property)
|
Collection |
getValidValues(QName property,
Class javaType)
|
String |
getWsdlLocation()
|
boolean |
hasProperty(QName property)
|
boolean |
isInitialValue(QName property,
Object value)
|
boolean |
isReadOnlyExternal(QName property)
|
boolean |
isStaticValue(QName property,
Object value)
|
boolean |
isValidValue(QName property,
Object value)
|
void |
removeProperty(QName property)
Removes the wsrmd:Property element with the given name. |
void |
setExtendedMetadata(QName property,
QName elementName,
String value)
This method allows you to extend a wsrmd:Property definition and provide application-specific metadata for a property. |
void |
setInitialValues(QName property,
Collection values)
|
void |
setLowerBound(QName property,
String value)
|
void |
setModifiability(QName property,
String value)
|
void |
setMutability(QName property,
String value)
|
void |
setPropertyName(QName currentProperty,
QName newProperty)
Change the name of one of the current wsrmd:Property elements. |
void |
setStaticValues(QName property,
Collection values)
|
void |
setUpperBound(QName property,
String value)
|
void |
setValidValues(QName property,
Collection values)
|
Methods inherited from interface org.apache.muse.util.xml.XmlSerializable |
---|
toXML, toXML |
Method Detail |
---|
void addProperty(QName property, String modifiability, String mutability)
property
- The name of the property this metadata refers to.modifiability
- Use WsrmdConstants.READ_ONLY or WsrmdConstants.READ_WRITE.mutability
- Use WsrmdConstants.CONSTANT, WsrmdConstants.APPENDABLE, or
WsrmdConstants.MUTABLE.WsrmdConstants
boolean canDelete(QName property)
property
-
boolean canInsert(QName property)
property
-
boolean canUpdate(QName property)
property
-
String getExtendedMetadata(QName property, QName elementName)
property
- elementName
- The name of the extended metadata item.
Collection getExtendedMetadataNames(QName property)
property
-
Collection getInitialValues(QName property)
property
-
getInitialValues(QName, Class)
Collection getInitialValues(QName property, Class javaType) throws SoapFault
property
- javaType
- The type whose serializer should be used to convert the
property values (DOM Elements) into POJOs.
SoapFault
- getValidValues(QName)
QName getInterface()
String getLowerBound(QName property)
property
-
String getModifiability(QName property)
canDelete(QName)
,
canInsert(QName)
,
canUpdate(QName)
String getMutability(QName property)
canDelete(QName)
,
canInsert(QName)
,
canUpdate(QName)
String getName()
Collection getPropertyNames()
Collection getStaticValues(QName property)
property
-
getStaticValues(QName, Class)
Collection getStaticValues(QName property, Class javaType) throws SoapFault
property
- javaType
- The type whose serializer should be used to convert the
property values (DOM Elements) into POJOs.
SoapFault
- getStaticValues(QName)
String getUpperBound(QName property)
property
-
Collection getValidValues(QName property)
property
-
getValidValues(QName, Class)
Collection getValidValues(QName property, Class javaType) throws SoapFault
property
- javaType
- The type whose serializer should be used to convert the
property values (DOM Elements) into POJOs.
SoapFault
- getValidValues(QName)
String getWsdlLocation()
boolean hasProperty(QName property)
property
-
boolean isInitialValue(QName property, Object value)
property
- value
-
boolean isReadOnlyExternal(QName property)
property
-
boolean isStaticValue(QName property, Object value)
property
- value
-
boolean isValidValue(QName property, Object value)
property
- value
-
void removeProperty(QName property)
property
- The name of the property to remove.void setExtendedMetadata(QName property, QName elementName, String value)
property
- The wsrmd:Property element to which the new element should be added.elementName
- The name of the extended metadata item.
param value
The value of the extended metadata item(may be null).void setInitialValues(QName property, Collection values) throws SoapFault
SoapFault
void setLowerBound(QName property, String value)
void setModifiability(QName property, String value)
property
- The wsrmd:Property element whose modifiability attribute will be changed.value
- WsrmdConstants.READ_ONLY or WsrmdConstants.READ_WRITEvoid setMutability(QName property, String value)
property
- The wsrmd:Property element whose mutability attribute will be changed.value
- WsrmdConstants.CONSTANT, WsrmdConstants.APPENDABLE, or WsrmdConstants.MUTABLEvoid setPropertyName(QName currentProperty, QName newProperty)
currentProperty
- newProperty
- void setStaticValues(QName property, Collection values) throws SoapFault
SoapFault
void setUpperBound(QName property, String value)
void setValidValues(QName property, Collection values) throws SoapFault
SoapFault
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |