com.ca.commons.datamodel
Interface DataModelItem

All Superinterfaces:

HasMetadata

All Known Subinterfaces:

DataModelClass, DataModelNamespace, DataModelProperty

All Known Implementing Classes:

ConcurrentModelClass, ConcurrentNamespace

public interface DataModelItem
extends HasMetadata

Field Summary

static char

NAME_DELIMITER DataModel name delimiter char

Method Summary

DataModelProperty	addMetaDataProperty(String name) Create an empty metadata property on this item with provided name and type, if one does not already exist.
String	getAbsoluteName()
DataModelItem	getContainer()
String	getDocumentation()
Collection<? extends DataModelProperty>	getMetaDataProperties() Returns collection of DataModelPropertys describing metadata.
DataModelProperty	getMetaDataProperty(String name)
boolean	getMetaDataPropertyBool(String boolPropName, boolean def) Helper function which returns boolean value for contained property with name boolPropName or def if no such property exists.
String	getMetaDataPropertyStr(String strPropName, String def) Helper function which returns String value for contained property with name strPropName or def if no such property exists.
DataModel	getModel()
String	getName()
boolean	isMetadata() Classes and properties can represent datamodel or metamodel.
void	setDocumentation(String doc)
void	setMetaDataPropertyBool(String boolPropName, boolean b) Helper function to ensure that the named metadata property is set to the provided value on this item.
void	setMetaDataPropertyStr(String strPropName, String s) Helper function to ensure that the named metadata property is set to the provided value on this item.

Methods inherited from interface com.ca.commons.datamodel.HasMetadata

mdObject, mdString, mdValue, mdValue, mdValue

Field Detail

NAME_DELIMITER

static final char NAME_DELIMITER

DataModel name delimiter char

See Also:

Constant Field Values

Method Detail

getAbsoluteName

String getAbsoluteName()

getName

String getName()

isMetadata

boolean isMetadata()

Classes and properties can represent datamodel or metamodel.

getMetaDataProperties

Collection<? extends DataModelProperty> getMetaDataProperties()

Returns collection of DataModelPropertys describing metadata.

getMetaDataProperty

@Nullable
DataModelProperty getMetaDataProperty(String name)
                                      throws DataModelException

Throws:

DataModelException

getContainer

@Nullable
DataModelItem getContainer()
                           throws DataModelException

Throws:

DataModelException

getModel

@NotNull
DataModel getModel()

getDocumentation

String getDocumentation()

setDocumentation

void setDocumentation(@NotNull
                      String doc)

addMetaDataProperty

DataModelProperty addMetaDataProperty(String name)

Create an empty metadata property on this item with provided name and type, if one does not already exist.

setMetaDataPropertyBool

void setMetaDataPropertyBool(String boolPropName,
                             boolean b)

Helper function to ensure that the named metadata property is set to the provided value on this item.

getMetaDataPropertyBool

boolean getMetaDataPropertyBool(String boolPropName,
                                boolean def)

Helper function which returns boolean value for contained property with name boolPropName or def if no such property exists.

setMetaDataPropertyStr

void setMetaDataPropertyStr(String strPropName,
                            String s)

Helper function to ensure that the named metadata property is set to the provided value on this item.

getMetaDataPropertyStr

String getMetaDataPropertyStr(String strPropName,
                              String def)

Helper function which returns String value for contained property with name strPropName or def if no such property exists.