net.sf.layoutParser.context

Class MaskCatalog

java.lang.Object

net.sf.layoutParser.context.MaskCatalog

public class MaskCatalog
extends Object

Holds the masks for the entries.

Author:

notivago

Constructor Summary

Constructors

Constructor and Description
MaskCatalog()

Method Summary

Methods

Modifier and Type	Method and Description
void	addAllMasks(Map<String,MaskTO> in)
void	addMask(MaskTO mask)
MaskTO	getMask(String namePrefix, String nameSufix) Retrieve's a mask according to their full name: namePrefix: The file name space nameSufix: The mask name The namePrefix for masks (and only masks) can be null when the mask is defined globally (for all the layout files) in the configuration file.
Map<String,MaskTO>	getMasks()
void	setMasks(Map<String,MaskTO> masks)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MaskCatalog

public MaskCatalog()

Method Detail

getMasks

public Map<String,MaskTO> getMasks()

setMasks

public void setMasks(Map<String,MaskTO> masks)

addMask

public void addMask(MaskTO mask)

addAllMasks

public void addAllMasks(Map<String,MaskTO> in)

getMask

public MaskTO getMask(String namePrefix,
             String nameSufix)

Retrieve's a mask according to their full name:

• namePrefix: The file name space
• nameSufix: The mask name

The namePrefix for masks (and only masks) can be null when the mask is defined globally (for all the layout files)
in the configuration file. Because of this special rule, this method first searches for the mask with the full name, and in case a name prefix was informed and no mask is returned then the method will search for the mask globally which means that will search only with the name sufix.

Parameters:

namePrefix - The first part of the name of the mask, which is the file nameSpace

nameSufix - The name of the layout

Returns:

The MaskTO