stag-autoschema(1p) [debian man page]

STAG-AUTOSCHEMA(1p)					User Contributed Perl Documentation				       STAG-AUTOSCHEMA(1p)

NAME

       stag-autoschema - writes the implicit stag-schema for a stag file

SYNOPSIS

	 stag-autoschema -w sxpr sample-data.xml

	 stag-autoschema -dtd sample-data.xml

DESCRIPTION

       Takes a stag compatible file (xml, sxpr, itext), or a file in any format plus a parser, and writes out the implicit underlying stag-schema

       stag-schema should look relatively self-explanatory.

       Here is an example stag-schema, shown in sxpr syntax:

	 (db
	  (person*
	   (name "s"
	   (address+
	    (address_type "s")
	    (street "s")
	    (street2? "s")
	    (city "s")
	    (zip? "s")))))

       The database db contains zero or more persons, each person has a mandatory name and at least one address.

       The cardinality mnemonics are as follows:

       +   1 or more

       ?   0 or one

       *   0 or more

       The default cardinality is 1

ARGUMENTS

       -p|parser FORMAT
	   FORMAT is one of xml, sxpr or itext, or the name of a perl module

	   xml assumed as default

       -dtd
	   exports schema as DTD

       -w|writer FORMAT
	   FORMAT is one of xml, sxpr or itext, or the name of a perl module, OR DTD

	   The default is sxpr

	   note that stag schemas exported as xml will be invalid xml, due to the use of symbols *, +, ? in the node names

LIMITATIONS

       not event based - memory usage becomes exhorbitant on large files; prepare a small sample beforehand

perl v5.10.0							    2008-12-23						       STAG-AUTOSCHEMA(1p)

STAG-GREP(1p)						User Contributed Perl Documentation					     STAG-GREP(1p)

NAME

       stag-grep - filters a stag file (xml, itext, sxpr) for nodes of interest

SYNOPSIS

	 stag-grep person -q name=fred file1.xml

	 stag-grep person 'sub {shift->get_name =~ /^A*/}' file1.xml

	 stag-grep -p My::Foo -w sxpr record 'sub{..}' file2

USAGE

	 stag-grep [-p|parser PARSER] [-w|writer WRITER] NODE -q tag=val FILE

	 stag-grep [-p|parser PARSER] [-w|writer WRITER] NODE SUB FILE

	 stag-grep [-p|parser PARSER] [-w|writer WRITER]  NODE -f PERLFILE FILE

DESCRIPTION

       parsers an input file using the specified parser (which may be a built in stag parser, such as xml) and filters the resulting stag tree
       according to a user-supplied subroutine, writing out only the nodes/elements that pass the test.

       the parser is event based, so it should be able to handle large files (although if the node you parse is large, it will take up more
       memory)

ARGUMENTS

       -p|parser FORMAT
	   FORMAT is one of xml, sxpr or itext, or the name of a perl module

	   xml assumed as default

       -w|writer FORMAT
	   FORMAT is one of xml, sxpr or itext, or the name of a perl module

       -c|count
	   prints the number of nodes that pass the test

       -filterfile|f
	   a file containing a perl subroutine (in place of the SUB argument)

       -q|query TAG1=VAL1 -q|query TAG2=VAL2 ...  -q|query TAGN=VALN
	   filters based on the field TAG

	   other operators can be used too - eg <, <=, etc

	   multiple q arguments can be passed in

	   for more complex operations, pass in your own subroutine, see below

       SUB a perl subroutine. this subroutine is evaluated evry time NODE is encountered - the stag object for NODE is passed into the subroutine.

	   if the subroutine passes, the node will be passed to the writer for display

       NODE
	   the name of the node/element we are filtering on

       FILE
	   the file to be parser. If no parser option is supplied, this is assumed to a be a stag compatible syntax (xml, sxpr or itext);
	   otherwise you should parse in a parser name or a parser module that throws stag events

SEE ALSO

       Data::Stag

perl v5.10.0							    2008-12-23							     STAG-GREP(1p)