Package mc.core.model.channel

Class ChannelMapBase

java.lang.Object

mc.core.model.base.EntityBase

mc.core.model.base.SimpleEntity

mc.core.model.channel.ChannelMapBase

All Implemented Interfaces:

Serializable, Iterable<ChannelMapField>, IBaseEntity, ICoreEntity, IEntity, ISortableEntity

Direct Known Subclasses:

ImportMap, PublicationProfileMap, PublicationProfileTypeMap

@MappedSuperclass
public abstract class ChannelMapBase
extends SimpleEntity
implements Iterable<ChannelMapField>

Base class for maps that determine which data of entities is relevant in import or export and optionally map the data to structures in flat files that represent the import or export medium.

mappedObjectClass: class of main object being exported or imported. Currently only Nodes are supported.
objectType: type must be given for typeManaged ComplexTypeEntity. Currently this must be a NodeType.

Properties applying to flat files only:
mapType: ChannelMapType gives the type or flat file based file
delimiter: for non-fixed length filed: gives the delimiter between fields
quoteChar: for non-fixed length filed: gives the quote-char to be used around text that contains the delimiter
hasHeader: set to true if table/file has a header line that provides the column names. If header is given the column names (header) must be provided for each mapField

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ChannelMapBase.ChannelMapType
static class	ChannelMapBase.Field

Nested classes/interfaces inherited from class mc.core.model.base.EntityBase

EntityBase.EntityComparator, EntityBase.Param

Field Summary

Fields

Modifier and Type	Field	Description
static final char	DELIMITER_CHAR	Default column delimiter in CSV files.
static final char	QUOTE_CHAR	Default escape character in CSV.

Fields inherited from class mc.core.model.base.EntityBase

INTDESC_COLUMN_LENGTH

Constructor Summary

Constructors

Constructor	Description
ChannelMapBase()
ChannelMapBase(ChannelMapBase source)

Method Summary

Modifier and Type	Method	Description
void	addMapField(ChannelMapField mapField)
char	getDelimiter()
boolean	getHasHeader()
List<ChannelMapField>	getMapFields()
List<ChannelMapField>	getMapFields(ChannelMapField.ChannelMapFieldType fieldType)
abstract IChannelMapHolder<? extends ChannelMapBase>	getMapHolder()	returns the instance of profile or profileType to which this channelMap belongs
String	getMappedObjectClass()
ChannelMapBase.ChannelMapType	getMapType()
ComplexTypeEntity	getObjectType()
char	getQuoteChar()
Iterator<ChannelMapField>	iterator()	for Iterable contract
void	setDelimiter(char delimiter)
void	setHasHeader(boolean hasHeader)
void	setMapFields(List<ChannelMapField> importMapFields)
void	setMappedObjectClass(String complexEntityClassName)
void	setMapType(ChannelMapBase.ChannelMapType mapType)
void	setObjectType(ComplexTypeEntity objectType)
void	setQuoteChar(char quoteChar)

Methods inherited from class mc.core.model.base.SimpleEntity

getId, getInternalDescription, getIsActive, setId, setIsActive

Methods inherited from class mc.core.model.base.EntityBase

equals, getCollection, getDescription, getDescription, getFlag, getIsSystem, getName, getName, getNamespace, getPrio, hashCode, setCollection, setDescription, setDescription, setFlag, setInternalDescription, setIsSystem, setName, setName, setNamespace, setPrio, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

DELIMITER_CHAR

public static final char DELIMITER_CHAR

Default column delimiter in CSV files. This conflicts with the proposal form RFC 4180 but allows to use CSV files from Excel versions that are sold in central and northern Europe.

See Also:

• Constant Field Values

QUOTE_CHAR

public static final char QUOTE_CHAR

Default escape character in CSV.

See Also:

• Constant Field Values

Constructor Details

ChannelMapBase

public ChannelMapBase()

ChannelMapBase

public ChannelMapBase(ChannelMapBase source)

Method Details

getHasHeader

public boolean getHasHeader()

Returns:

Whether exported CSV files have a header row.

setHasHeader

public void setHasHeader(boolean hasHeader)

Parameters:

hasHeader - Whether exported CSV files have a header row.

getMappedObjectClass

public String getMappedObjectClass()

setMappedObjectClass

public void setMappedObjectClass(String complexEntityClassName)

getDelimiter

public char getDelimiter()

setDelimiter

public void setDelimiter(char delimiter)

getMapType

public ChannelMapBase.ChannelMapType getMapType()

setMapType

public void setMapType(ChannelMapBase.ChannelMapType mapType)

getMapFields

public List<ChannelMapField> getMapFields()

setMapFields

public void setMapFields(List<ChannelMapField> importMapFields)

addMapField

public void addMapField(ChannelMapField mapField)

getObjectType

public ComplexTypeEntity getObjectType()

setObjectType

public void setObjectType(ComplexTypeEntity objectType)

getQuoteChar

public char getQuoteChar()

setQuoteChar

public void setQuoteChar(char quoteChar)

getMapHolder

public abstract IChannelMapHolder<? extends ChannelMapBase> getMapHolder()

returns the instance of profile or profileType to which this channelMap belongs

iterator

public Iterator<ChannelMapField> iterator()

for Iterable contract

Specified by:

iterator in interface Iterable<ChannelMapField>

getMapFields

public List<ChannelMapField> getMapFields(ChannelMapField.ChannelMapFieldType fieldType)