relpipe-data/specification.xml
branchv_0
changeset 156 2be00f14dc78
parent 154 aec6545b2350
child 157 65b71e6a0973
equal deleted inserted replaced
155:63cc1f6e8e3f 156:2be00f14dc78
    12 			and the incompatible changes might (and will) come before the v1.0.0 release.
    12 			and the incompatible changes might (and will) come before the v1.0.0 release.
    13 			Please stay tuned for this stable version which will deliver specification such complete and precise 
    13 			Please stay tuned for this stable version which will deliver specification such complete and precise 
    14 			that independent implementation of the format will be possible.
    14 			that independent implementation of the format will be possible.
    15 		</p>
    15 		</p>
    16 		
    16 		
    17 		<h2>Stream structure structure</h2>
    17 		<h2>
       
    18 			<m:name/> data format
       
    19 		</h2>
       
    20 			
       
    21 		<h3>Stream structure structure</h3>
    18 		
    22 		
    19 		
    23 		
    20 		<m:tabulka>
    24 		<m:tabulka>
    21 			id	name	description
    25 			id	name	description
    22 			0x1D	start	start of the relation
    26 			0x1D	start	start of the relation
    23 			0x1E	record	start of the record
    27 			0x1E	record	start of the record
    24 		</m:tabulka>
    28 		</m:tabulka>
    25 		
    29 		
    26 		
    30 		
    27 		<h2>Data types</h2>
    31 		<h3>Data types</h3>
    28 		
    32 		
    29 		<p>Currently, there are only three data types.</p>
    33 		<p>Currently, there are only three data types.</p>
    30 		
    34 		
    31 		<m:tabulka>
    35 		<m:tabulka>
    32 			typeId	code	description
    36 			typeId	code	description
    33 			0x01	boolean	logical value, true/false
    37 			0x01	boolean	logical value, true/false
    34 			0x02	integer	unsigned integer number of arbitrary length
    38 			0x02	integer	unsigned integer number of arbitrary length
    35 			0x03	string	character string in UTF-8
    39 			0x03	string	character string in UTF-8
    36 		</m:tabulka>
    40 		</m:tabulka>
    37 		
    41 		
       
    42 		<h2>Libraries</h2>
       
    43 		
       
    44 		<h3>relpipe-lib-writer</h3>
       
    45 		
       
    46 		<p>Wraps an output stream (usually STDOUT), accepts method calls (relations, attributes) and generates <m:name/> data on the stream.</p>
       
    47 		
       
    48 		<h3>relpipe-lib-reader</h3>
       
    49 		
       
    50 		<p>
       
    51 			Wraps an input stream (usually STDIN). The caller creates and sets handlers (zero or more) using <code>addHandler()</code> and then calls <code>process()</code> method.
       
    52 			During this method call, the reader reads the input and calls the handlers.
       
    53 			Handlers receive relations and attributes.
       
    54 		</p>
       
    55 		
       
    56 		<h2>Tools</h2>
       
    57 		
       
    58 		<h3>relpipe-in-cli</h3>
       
    59 		<h3>relpipe-in-fstab</h3>
       
    60 		<h3>relpipe-out-tabular</h3>
       
    61 		<h3>relpipe-out-xml</h3>
       
    62 		<h3>relpipe-out-qui</h3>
       
    63 		
    38 	</text>
    64 	</text>
    39 
    65 
    40 </stránka>
    66 </stránka>