org.vishia.msgDispatch

Class MsgConfig

java.lang.Object

org.vishia.msgDispatch.MsgConfig

All Implemented Interfaces:

MsgText_ifc

public class MsgConfig
extends java.lang.Object
implements MsgText_ifc

This class holds configuration information about messages, especially the message text associated to a ident number.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MsgConfig.FileOutput
static class	MsgConfig.MsgConfigZbnf From Zbnf: This class is used as setting class for Zbnf2Java, therefore all is public.

Nested classes/interfaces inherited from interface org.vishia.msgDispatch.MsgText_ifc

MsgText_ifc.MsgConfigItem

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.Integer,MsgText_ifc.MsgConfigItem>	indexIdentNr Index over all ident numbers.
(package private) java.util.List<MsgConfig.FileOutput>	listFileOutput
static int	version version, history and license: 2014-12-20 Hartmut new: Reads information for file outputs, see MsgConfig.FileOutput, in preparing, not used yet.

Constructor Summary

Constructors

Constructor and Description
MsgConfig()

Method Summary

Modifier and Type	Method and Description
java.util.Collection<MsgText_ifc.MsgConfigItem>	getListItems()
java.lang.String	getMsgText(int ident) Returns the text to a message ident.
int	getNrofItems()
java.lang.String	readConfig(java.io.File fileConfig) Reads the configuration from a file with given syntax.
int	setMsgDispaching(MsgDispatcher msgDispatcher, java.lang.String chnChars) Sets the dispatching of all captured messages.
private void	setRange(MsgDispatcher msgDispatcher, java.lang.String dstMsg, int firstIdent, int lastIdent, java.lang.String chnChars)

Methods inherited from class java.lang.Object

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

Field Detail

version

public static final int version

version, history and license:

• 2014-12-20 Hartmut new: Reads information for file outputs, see MsgConfig.FileOutput, in preparing, not used yet.
• 2014-12-20 Hartmut bugfix: closes the read file, important for long running applications.
• 2013-03-31 Hartmut new readConfig(File) now regards 1000..1099 (range), $$ for ident strings, re-read of the config is possible (experience).
• 2013-02-24 Hartmut new getListItems(), move MsgConfigItem to MsgText_ifc.
• 2010-08-00 Hartmut created

Copyright/Copyleft: For this source the LGPL Lesser General Public License, published by the Free Software Foundation is valid. It means:

1. You can use this source without any restriction for any desired purpose.
2. You can redistribute copies of this source to everybody.
3. Every user of this source, also the user of redistribute copies with or without payment, must accept this license for further using.
4. But the LPGL is not appropriate for a whole software product, if this source is only a part of them. It means, the user must publish this part of source, but don't need to publish the whole source of the own product.
5. You can study and modify (improve) this source for own using or for redistribution, but you have to license the modified sources likewise under this LGPL Lesser General Public License. You mustn't delete this Copyright/Copyleft inscription in this source file.

If you are intent to use this sources without publishing its usage, you can get a second license subscribing a special contract with the author.

See Also:

Constant Field Values

listFileOutput

java.util.List<MsgConfig.FileOutput> listFileOutput

indexIdentNr

protected final java.util.Map<java.lang.Integer,MsgText_ifc.MsgConfigItem> indexIdentNr

Index over all ident numbers.

Constructor Detail

MsgConfig

public MsgConfig()

Parameters:

log -

sPathCfg -

Method Detail

readConfig

public java.lang.String readConfig(java.io.File fileConfig)

Reads the configuration from a file with given syntax.
Syntax:

MsgConfig::= {  } \e.

item::= <#?identNr>[..<#?identNrLast>]   <*|\t|\ \ ?dst> [$$<*|\r|\n|\t|\ \ |$$|:|;?identText>[??]]  <*|\r|\n|\t|\ \ ?text>.
 

The dst is a String with one or more characters which are associated to output channels of the message dispatcher. The association between the characters and the outputs are made be the routine setMsgDispaching(MsgDispatcher, String). Examples:

1303 i x  $$Ident text is equal to - the output text; some more %d values; val=%d;
1400 i d  $$Ident text from - internal$$Other output text; val=%d; val2=%d;
1500 i d  $$Ident text from - internal$$
 

Any line is designated with the semantic 'line'. A line is build by the shown syntax elements. The semantic have to be used like shown. The semantic identifier are given by the element names of the classes MsgConfig.MsgConfigZbnf and MsgConfigItem. The syntax can be another one.

Parameters:

fileConfig -

Returns:

null if successfully, an error hint on error.

getNrofItems

public int getNrofItems()

setMsgDispaching

public int setMsgDispaching(MsgDispatcher msgDispatcher,
                            java.lang.String chnChars)

Sets the dispatching of all captured messages.

Parameters:

msgDispatcher -

chnChars - The characters which are associated to dstBits 0x0001, 0x0002 etc in MsgDispatcher.setOutputRange(int, int, int, int, int) in respect to the characters stored in the message config dst field. For example "df" if the dstBit 0x0001 is associated to the display and the dstBit 0x0002 is associated to an output file and "d" means "Display" and "f" means "File" in the config text.

Returns:

The last message ident number which was used by this configuration.

setRange

private void setRange(MsgDispatcher msgDispatcher,
                      java.lang.String dstMsg,
                      int firstIdent,
                      int lastIdent,
                      java.lang.String chnChars)

getListItems

public java.util.Collection<MsgText_ifc.MsgConfigItem> getListItems()

Specified by:

getListItems in interface MsgText_ifc

getMsgText

public java.lang.String getMsgText(int ident)

Returns the text to a message ident.

Specified by:

getMsgText in interface MsgText_ifc

Parameters:

ident - the absolute value is used to find the text.

Returns:

null if no message text was found.

See Also:

MsgText_ifc.getMsgText(int)