Synalyze It!  1.1
 All Classes Functions Pages
Public Member Functions | List of all members
Grammar Class Reference

The Grammar class. More...

Public Member Functions

String getEncoding ()
 Get encoding. More...
 
String getDescription ()
 Get grammar description. More...
 
 setDescription (String description)
 Set grammar description. More...
 
void addStructure (Structure structure)
 Add structure. More...
 
void insertStructureAtIndex (Structure structure, int index)
 Insert structure at index. More...
 
void deleteStructureAtIndex (int index)
 Delete structure at index. More...
 
Structure getRootNode ()
 Get root node (structure) More...
 
void setStartStructure (Structure startStructure)
 Set start structure. More...
 
Structure getStructureByName (String name)
 Get structure by name. More...
 
Structure getStructureByIndex (int index)
 Get structure by index. More...
 
int getStructureCount ()
 Get number of structures. More...
 
 setName (String name)
 Set grammar name. More...
 
String getName ()
 get grammar name More...
 
 setUTI (String UTI)
 Set UTI grammar is valid for. More...
 
String getUTI ()
 Get UTI grammar is valid for. More...
 
 setFileExtension (String fileExtension)
 Set file extension grammar is valid for. More...
 
String getFileExtension ()
 Get file extension grammar is valid for. More...
 

Detailed Description

The Grammar class.

A grammar with all structures and their elements

Author
Andreas Pehnack
Date
2009-08-03

Member Function Documentation

void addStructure ( Structure  structure)

Add structure.

Author
Andreas Pehnack
Date
2013-04-14
Parameters
[in]structureThe structure to be appended
See Also
getRootNode()
void deleteStructureAtIndex ( int  index)

Delete structure at index.

Author
Andreas Pehnack
Date
2013-04-14
Parameters
[in]indexIndex where structure should be deleted
See Also
getRootNode()
String getDescription ( )

Get grammar description.

Author
Andreas Pehnack
Date
2012-05-12
Returns
The description of the grammar
See Also
setDescription()
String getEncoding ( )

Get encoding.

Author
Andreas Pehnack
Date
2009-12-01
Returns
The encoding used for the internal representation of the string
String getFileExtension ( )

Get file extension grammar is valid for.

Author
Andreas Pehnack
Date
2013-04-14
Returns
The file extension
See Also
setFileExtension()
String getName ( )

get grammar name

Author
Andreas Pehnack
Date
2010-02-21
Returns
The name of the grammar
See Also
setName()
Structure getRootNode ( )

Get root node (structure)

Author
Andreas Pehnack
Date
2010-06-06
Returns
The the structure enclosing all other structures
See Also
getStructureByName
Structure getStructureByIndex ( int  index)

Get structure by index.

Author
Andreas Pehnack
Date
2009-08-03
Parameters
[in]indexIndex of the structure to get
Returns
The structure you asked for or NULL if there is no structure with the name you passed
See Also
getStructureByName
Structure getStructureByName ( String  name)

Get structure by name.

Author
Andreas Pehnack
Date
2009-08-03
Parameters
[in]nameName of the structure to get
Returns
The structure you asked for or NULL if there is no structure with the name you passed
See Also
getStructureByID
int getStructureCount ( )

Get number of structures.

Author
Andreas Pehnack
Date
2009-08-03
Returns
The number of structures in this grammar
See Also
getStructureByIndex
String getUTI ( )

Get UTI grammar is valid for.

Author
Andreas Pehnack
Date
2013-04-14
Returns
The UTI
See Also
setUTI()
void insertStructureAtIndex ( Structure  structure,
int  index 
)

Insert structure at index.

Author
Andreas Pehnack
Date
2013-04-14
Parameters
[in]structureThe structure to be inserted
[in]indexIndex where structure should be inserted
See Also
getRootNode()
setDescription ( String  description)

Set grammar description.

Author
Andreas Pehnack
Date
2009-08-16
Parameters
[in]descriptionThe description of the grammar
See Also
getDescription()
setFileExtension ( String  fileExtension)

Set file extension grammar is valid for.

Author
Andreas Pehnack
Date
2013-04-14
Parameters
[in]fileExtensionThe file extension to be set
See Also
getFileExtension()
setName ( String  name)

Set grammar name.

Author
Andreas Pehnack
Date
2009-08-16
Parameters
[in]nameThe name of the grammar
See Also
getName()
void setStartStructure ( Structure  startStructure)

Set start structure.

Author
Andreas Pehnack
Date
2010-06-06
Returns
The structure where parsing begins
See Also
getRootNode
setUTI ( String  UTI)

Set UTI grammar is valid for.

Author
Andreas Pehnack
Date
2013-04-14
Parameters
[in]UTIThe UTI
See Also
getUTI()

The documentation for this class was generated from the following file: