Laboratoire ICAR » Plateforme TXM

Add an advanced preference page to manage the TXM startup command line (modifying TXM.ini).
Defines which arguments must be editable and create some input fields with checks for them.

Here is the default content of the TXM.ini (Windows version):

-Xms512m
-Xmx1024m
-Dfile.encoding=UTF-8
-Dorg.eclipse.ecf.provider.filetransfer.excludeContributors=org.eclipse.ecf.provider.filetransfer.httpclient4
-Dorg.eclipse.ecf.provider.filetransfer.retrieve.connectTimeout=6000
-Dorg.eclipse.ecf.provider.filetransfer.retrieve.retryAttempts=5
-XX:MaxPermSize=256m

We may also add these ones to easily tune the P2 updates:

-Dorg.eclipse.ecf.provider.filetransfer.retrieve.readTimeout=10000
-Dorg.eclipse.ecf.provider.filetransfer.retrieve.retryAttempts=30
-Dorg.eclipse.ecf.provider.filetransfer.retrieve.closeTimeout=1000

[SLH, 31/1/24]

TXM memory size preference¶

TXM is sensible to memory size for medium size corpora.
We must help users tune TXM memory size easily.
TXM.ini is a too low level way to parameter TXM memory size.

Design¶

• TXM memory size management should be in the 'TXM > Advanced' preferences entry, in a new 'Memory' section after the 'Messages' section
• the 'Memory size' parameter UI should be simple (and less flexible than the Java memory parameters)
  • for example tuning both -Xms and -Xmx jvm options from a single public memory size number
    • for example -Xms value = public-memory-size/2 and -Xmx = public-memory-size
• the 'Memory size' parameter value must be expressable with various ways : Java ways may be sufficient (i.e. '10g’ or '10G' for 10 GB, ‘10m’ for 10 MB, and ‘10k’ for 10 KB)
• the 'Memory size' parameter value must be controled and refused with an error message if not correct : e.g. it must respect a regex pattern, eg /[0-9]+ ?[gGmMkK]/
• applying a new preference value must propose to restart TXM to take effect

Some related behaviors¶

• general TXM Java heapspace exception error messages should trigger a modal dialog box suggesting to rize TXM memory size [preference]
• more specifically, in case of Java heapspace exception at startup - for example after a restart following the setting of a new memory size value - a dialog box should suggest to reset the memory size to a previous [working] value or a factory value, and suggest to restart