Package org.apache.cayenne.configuration
Class DataChannelDescriptor
- java.lang.Object
-
- org.apache.cayenne.configuration.DataChannelDescriptor
-
- All Implemented Interfaces:
Serializable,ConfigurationNode,XMLSerializable
public class DataChannelDescriptor extends Object implements ConfigurationNode, Serializable, XMLSerializable
A descriptor of a DataChannel normally loaded from XML configuration.- Since:
- 3.1
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected ResourceconfigurationSourceprotected Collection<DataMap>dataMapsprotected StringdefaultNodeNameprotected Stringnameprotected Collection<DataNodeDescriptor>nodeDescriptorsprotected Map<String,String>propertiesstatic StringSCHEMA_XSDThe namespace in which the data map XML file will be created.static StringSCHEMA_XSD_LOCATION
-
Constructor Summary
Constructors Constructor Description DataChannelDescriptor()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description <T> TacceptVisitor(ConfigurationNodeVisitor<T> visitor)voidencodeAsXML(XMLEncoder encoder, ConfigurationNodeVisitor delegate)Prints itself as XML to the provided XMLEncoder.ResourcegetConfigurationSource()DataMapgetDataMap(String name)Collection<DataMap>getDataMaps()StringgetDefaultNodeName()Returns the name of the DataNode that should be used as the default if a DataMap is not explicitly linked to a node.StringgetName()DataNodeDescriptorgetNodeDescriptor(String name)Collection<DataNodeDescriptor>getNodeDescriptors()Map<String,String>getProperties()voidsetConfigurationSource(Resource configurationSource)voidsetDefaultNodeName(String defaultDataNodeName)voidsetName(String name)
-
-
-
Field Detail
-
SCHEMA_XSD
public static final String SCHEMA_XSD
The namespace in which the data map XML file will be created.- See Also:
- Constant Field Values
-
SCHEMA_XSD_LOCATION
public static final String SCHEMA_XSD_LOCATION
- See Also:
- Constant Field Values
-
name
protected String name
-
dataMaps
protected Collection<DataMap> dataMaps
-
nodeDescriptors
protected Collection<DataNodeDescriptor> nodeDescriptors
-
configurationSource
protected transient Resource configurationSource
-
defaultNodeName
protected String defaultNodeName
-
-
Method Detail
-
encodeAsXML
public void encodeAsXML(XMLEncoder encoder, ConfigurationNodeVisitor delegate)
Description copied from interface:XMLSerializablePrints itself as XML to the provided XMLEncoder.- Specified by:
encodeAsXMLin interfaceXMLSerializable
-
acceptVisitor
public <T> T acceptVisitor(ConfigurationNodeVisitor<T> visitor)
- Specified by:
acceptVisitorin interfaceConfigurationNode
-
getName
public String getName()
-
setName
public void setName(String name)
-
getDataMaps
public Collection<DataMap> getDataMaps()
-
getNodeDescriptors
public Collection<DataNodeDescriptor> getNodeDescriptors()
-
getNodeDescriptor
public DataNodeDescriptor getNodeDescriptor(String name)
-
getConfigurationSource
public Resource getConfigurationSource()
-
setConfigurationSource
public void setConfigurationSource(Resource configurationSource)
-
getDefaultNodeName
public String getDefaultNodeName()
Returns the name of the DataNode that should be used as the default if a DataMap is not explicitly linked to a node.
-
setDefaultNodeName
public void setDefaultNodeName(String defaultDataNodeName)
-
-