org.jahia.services.content.nodetypes

Class JahiaCndReaderLegacy

java.lang.Object

org.jahia.services.content.nodetypes.JahiaCndReaderLegacy

public class JahiaCndReaderLegacy
extends Object

JahiaCndReader. Parses node type definitions written in the compact node type definition format and returns a list of JahiaNodeTypeDef objects that can then be used to register node types.

The EBNF grammar of the compact node type definition:

 cnd ::= ns_mapping* node_type_def+

 ns_mapping ::= "<" prefix "=" namespace ">"

 prefix ::= string

 namespace ::= string

 node_type_def ::= node_type_name [super_types] [options] {property_def | node_def}

 node_type_name ::= "[" string "]"

 super_types ::= ">" string_list

 options ::= orderable_opt | mixin_opt | orderable_opt mixin_opt | mixin_opt orderable_opt

 orderable_opt ::= "orderable" | "ord" | "o"

 mixin_opt ::= "mixin" | "mix" | "m"

 property_def ::= "-" property_name [property_type_decl] [default_values] [attributes] [value_constraints]

 property_name ::= string

 property_type_decl ::= "(" property_type ")"

 property_type ::= "STRING" | "String |"string" |
                   "BINARY" | "Binary" | "binary" |
                   "LONG" | "Long" | "long" |
                   "DOUBLE" | "Double" | "double" |
                   "BOOLEAN" | "Boolean" | "boolean" |
                   "DATE" | "Date" | "date" |
                   "NAME | "Name | "name |
                   "PATH" | "Path" | "path" |
                   "REFERENCE" | "Reference" | "reference" |
                   "UNDEFINED" | "Undefined" | "undefined" | "*"


 default_values ::= "=" string_list

 value_constraints ::= "<" string_list

 node_def ::= "+" node_name [required_types] [default_type] [attributes]

 node_name ::= string

 required_types ::= "(" string_list ")"

 default_type ::= "=" string

 attributes ::= "primary" | "pri" | "!" |
                "autocreated" | "aut" | "a" |
                "mandatory" | "man" | "m" |
                "protected" | "pro" | "p" |
                "multiple" | "mul" | "*" |
                "COPY" | "Copy" | "copy" |
                "VERSION" | "Version" | "version" |
                "INITIALIZE" | "Initialize" | "initialize" |
                "COMPUTE" | "Compute" | "compute" |
                "IGNORE" | "Ignore" | "ignore" |
                "ABORT" | "Abort" | "abort"

 string_list ::= string {"," string}

 string ::= quoted_string | unquoted_string

 quoted_string :: = "'" unquoted_string "'"

 unquoted_string ::= [A-Za-z0-9:_]+
 

Field Summary

Fields

Modifier and Type	Field and Description
protected String	currentToken the current token
protected String	filename
protected LexerLegacy	lexer the underlying LexerLegacy
protected List<ExtendedNodeType>	nodeTypesList the list of parsed nodetype defs
protected NodeTypeRegistry	registry the registry where the types should be stored
protected String	systemId

Constructor Summary

Constructors

Constructor and Description
JahiaCndReaderLegacy(Reader r, String filename, String systemId, NodeTypeRegistry registry) Creates a new CND reader.

Method Summary

Modifier and Type	Method and Description
protected boolean	currentTokenEquals(char c) Checks if the currentToken is semantically equal to the given argument.
protected boolean	currentTokenEquals(String s) Checks if the currentToken is semantically equal to the given argument.
protected boolean	currentTokenEquals(String[] s) Checks if the currentToken is semantically equal to the given argument.
List<ExtendedNodeType>	getNodeTypesList() Returns the list of parsed nodetype definitions.
protected void	nextToken() Gets the next token from the underlying LexerLegacy.
void	parse() Parses the definition
protected Name	parseName(String name)

Methods inherited from class java.lang.Object

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

Field Detail

systemId

protected String systemId

filename

protected String filename

registry

protected NodeTypeRegistry registry

the registry where the types should be stored

nodeTypesList

protected List<ExtendedNodeType> nodeTypesList

the list of parsed nodetype defs

lexer

protected LexerLegacy lexer

the underlying LexerLegacy

currentToken

protected String currentToken

the current token

Constructor Detail

JahiaCndReaderLegacy

public JahiaCndReaderLegacy(Reader r,
                            String filename,
                            String systemId,
                            NodeTypeRegistry registry)
                     throws ParseException,
                            IOException

Creates a new CND reader.

Parameters:

r -

Throws:

ParseException

IOException

Method Detail

getNodeTypesList

public List<ExtendedNodeType> getNodeTypesList()

Returns the list of parsed nodetype definitions.

Returns:

a List of JahiaNodeTypeDef objects

parse

public void parse()
           throws ParseException,
                  IOException,
                  javax.jcr.RepositoryException

Parses the definition

Throws:

ParseException

IOException

javax.jcr.RepositoryException

nextToken

protected void nextToken()
                  throws ParseException

Gets the next token from the underlying LexerLegacy.

Throws:

ParseException - if the LexerLegacy fails to get the next token.

See Also:

LexerLegacy.getNextToken()

currentTokenEquals

protected boolean currentTokenEquals(String[] s)

Checks if the currentToken is semantically equal to the given argument.

Parameters:

s - the tokens to compare with

Returns:

true if equals; false otherwise.

currentTokenEquals

protected boolean currentTokenEquals(char c)

Checks if the currentToken is semantically equal to the given argument.

Parameters:

c - the tokens to compare with

Returns:

true if equals; false otherwise.

currentTokenEquals

protected boolean currentTokenEquals(String s)

Checks if the currentToken is semantically equal to the given argument.

Parameters:

s - the tokens to compare with

Returns:

true if equals; false otherwise.

parseName

protected Name parseName(String name)
                  throws ParseException

Throws:

ParseException