org.vishia.util

Class DataShow

java.lang.Object

org.vishia.util.ObjectId

org.vishia.util.DataShow

public class DataShow
extends ObjectId

This class supports output of the content of any instance maybe with associated other Objects. It shows the data structure of a class with its content as a snap shoot.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DataShow.ExcludeShowContent If a Field is designated with this annotation then the content is not shown.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.util.Queue<java.lang.Object>	newInstances
static java.lang.String	sVersion Version, history and license.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	DataShow()

Method Summary

Modifier and Type	Method and Description
private static void	appendContent(java.lang.Object data, java.lang.Appendable out)
static void	dataTree(java.lang.Object data, java.lang.Appendable out, int maxRecurs)
static void	dataTreeXml(java.lang.Object data, java.lang.Appendable out, int maxRecurs)
private static boolean	outData(int recurs, int maxRecurs, java.lang.Object data, java.lang.Appendable out, boolean bXML, java.util.Map<java.lang.String,java.lang.Object> processedAlready) Output of a complex data class.
private void	outData(java.lang.Object data, java.lang.Appendable out, boolean bNoHash) Output of a complex data class.
private void	outDataShort(java.lang.Object data, java.lang.Class<?> type, java.lang.Appendable out) Output to one element.
private void	outField(java.lang.String sInfo, java.lang.Object data, java.lang.Class<?> type, java.lang.reflect.Field field, java.lang.Appendable out, int recursiveCount)
static void	outHtml(java.lang.Object data, java.lang.Appendable out) Generates a html file which contains the description of all data contained in referred in the given data instance.
static void	outHtml(java.lang.Object data, java.lang.Appendable out, boolean bNoHash) Same as outHtml(Object, Appendable) but content with or without hash is able to control
(package private) static void	outIndent(int recurs, java.lang.Appendable out, boolean bXml)
private java.lang.String	strData(java.lang.Object data, boolean bNoHash)
private static boolean	XXXoutData(int recurs, java.lang.String sName, java.lang.Object dataField, java.lang.Appendable out, boolean bXML)

Methods inherited from class org.vishia.util.ObjectId

allInstances, getIdFromHash, getPerHash, getPerId, instanceId, toStringNoHash

Methods inherited from class java.lang.Object

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

Field Detail

sVersion

public static final java.lang.String sVersion

Version, history and license.

• 2019-05-28 Hartmut fix: Some correction to present < in the html. It should be presented with <.
• 2017-07-29 Hartmut new: outData(Object, Appendable, boolean) can decide whether the true hash code is shown (for search the instance proper to a Object.toString()-output with @hash or a unique hash is shown for compare ability of 2 html files.j
• 2015-11-03 Hartmut new: possibility of hyperlink to any instance via toString-anchor.
• 2015-08-01 Hartmut chg: Instead hash-code as link label use the #instanceId(Object). The advantage: If the same data are used in a second session (repeated invocation of the same for example conversion process) then the identification is the same. The hash code depends on the memory address, which depends on the situation on the operation system. With them the generated html outputs are able to compare by a text difference tool. With that intension the standard toString() output are changed, instead "type@address" "type@instanceId" is replaced.
• 2014-11-09 Hartmut new: with html output
• 2014-07-24 Hartmut chg: Argument maxRecurs necessary.
• 2014-07-24 Hartmut chg: Move the algorithm from to this class org.vishia.util.DataShow. It is an own topic.
• 2014-06-29 Hartmut chg move the algorithm form srcJava_Zbnf:/org/vishia/zcmd/OutputDataTree to org/vishia/jzcmd/JZcmdTester.
• 2013-07-28 Hartmut chg/new: dataTree now writes XML
• 2013-03-10 Hartmut chg/new: dataTree supports superclass content.
• 2012-12-00 Hartmut improved: dataTree circular references with @ 1234 (address) to mark it.
• 2012-10-08 created. dataTree A presentation of the content of a Java data tree was necessary.

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

newInstances

java.util.Queue<java.lang.Object> newInstances

Constructor Detail

DataShow

private DataShow()

Method Detail

dataTreeXml

public static void dataTreeXml(java.lang.Object data,
                               java.lang.Appendable out,
                               int maxRecurs)
                        throws java.io.IOException

Throws:

java.io.IOException

dataTree

public static void dataTree(java.lang.Object data,
                            java.lang.Appendable out,
                            int maxRecurs)
                     throws java.io.IOException

Throws:

java.io.IOException

outData

private static boolean outData(int recurs,
                               int maxRecurs,
                               java.lang.Object data,
                               java.lang.Appendable out,
                               boolean bXML,
                               java.util.Map<java.lang.String,java.lang.Object> processedAlready)
                        throws java.io.IOException

Output of a complex data class.

Parameters:

recurs -

data -

out -

bXML -

Returns:

true: one line data, end with "/ >", false: more as one line.

Throws:

java.io.IOException

outHtml

public static void outHtml(java.lang.Object data,
                           java.lang.Appendable out)
                    throws java.io.IOException

Generates a html file which contains the description of all data contained in referred in the given data instance. The given data instance is evaluated with all files, also private, using reflection. All references are evaluated in the same kind. The references are referenced in the html presentation using html links inside the generated file. If data refers a large amount of other instances, maybe with a large list etc then the created file is large. There is no limitation. Circulate references are detected, any Object is presented only one time.

Parameters:

data - Any Object.

out - To write

Throws:

java.io.IOException

outHtml

public static void outHtml(java.lang.Object data,
                           java.lang.Appendable out,
                           boolean bNoHash)
                    throws java.io.IOException

Same as outHtml(Object, Appendable) but content with or without hash is able to control

Parameters:

data -

out -

bNoHash - true than a @ hash from toString() will be replaced by the internal id to save compare ability.

Throws:

java.io.IOException

outDataShort

private void outDataShort(java.lang.Object data,
                          java.lang.Class<?> type,
                          java.lang.Appendable out)
                   throws java.io.IOException

Output to one element.

Parameters:

data -

type -

out -

Throws:

java.io.IOException

outData

private void outData(java.lang.Object data,
                     java.lang.Appendable out,
                     boolean bNoHash)
              throws java.io.IOException

Output of a complex data class.

Parameters:

recurs -

data -

out -

bXML -

Throws:

java.io.IOException

strData

private java.lang.String strData(java.lang.Object data,
                                 boolean bNoHash)

outField

private void outField(java.lang.String sInfo,
                      java.lang.Object data,
                      java.lang.Class<?> type,
                      java.lang.reflect.Field field,
                      java.lang.Appendable out,
                      int recursiveCount)
               throws java.io.IOException

Parameters:

sName -

sType -

data - If a field is given, then the data where the field is found, else the data itself.

type - Type of a reference or type of instance to show.

field - maybe null

out -

Throws:

java.io.IOException

outIndent

static void outIndent(int recurs,
                      java.lang.Appendable out,
                      boolean bXml)
               throws java.io.IOException

Throws:

java.io.IOException

XXXoutData

private static boolean XXXoutData(int recurs,
                                  java.lang.String sName,
                                  java.lang.Object dataField,
                                  java.lang.Appendable out,
                                  boolean bXML)
                           throws java.io.IOException

Throws:

java.io.IOException

appendContent

private static void appendContent(java.lang.Object data,
                                  java.lang.Appendable out)
                           throws java.io.IOException

Throws:

java.io.IOException