outils.regles
Class Regle

java.lang.Object
  outils.regles.Regle

Direct Known Subclasses:

RegleEnsemble, RegleMot

public abstract class Regle
extends java.lang.Object

décrit une règle dans nat

Field Summary

protected boolean	actif Vrai si la règle est active dans la configuration
protected java.lang.String	description Description de la règle ou catégorie de règle Exemples: "Locution", "Le préfixe CONTRE ne s'abrège que lorsqu'il est suivi d'un trait d'union")
protected boolean	peda Vrai si la règle est une règle pédagogique (non nécessaire dans la norme) dans la configuration
protected java.lang.String	reference Référence de la règle (pour l'instant, issue du manuel d'abrégé de l'AVH).

Constructor Summary

Regle(java.lang.String d, java.lang.String ref)

Regle(java.lang.String d, java.lang.String ref, boolean a)

Regle(java.lang.String d, java.lang.String ref, boolean a, boolean p)

Method Summary

abstract boolean	equals(java.lang.Object o) Vérifie si deux règles sont identiques
abstract java.lang.String	getXML() Renvoie un noeud xml sous forme de chaine représentant la règle
boolean	isActif()
boolean	isPeda()
void	setActif(boolean a)
void	setPeda(boolean p)
abstract java.lang.String	toString() Pour obliger la redéfinition de toString() de la Classe Object

Methods inherited from class java.lang.Object

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

Field Detail

description

protected java.lang.String description

Description de la règle ou catégorie de règle

Exemples:

• "Locution",
• "Le préfixe CONTRE ne s'abrège que lorsqu'il est suivi d'un trait d'union")

reference

protected java.lang.String reference

Référence de la règle (pour l'instant, issue du manuel d'abrégé de l'AVH).

Conventions de nommage:

• Chapitre: chiffres romains: la règle est définie dans un chapître (par exemple, locution, mots abrégés par un seul signe, etc)
• Règle d'abréviation: chiffre arabes: n° de la règle dans le manuel
• Règle non présente dans le manuel: Source de la règle + référence dans la source: par exemple "Méthode Le Rest/Perdoux, édition 2008, page x, §y

Il est recommandé de donner une référence complète en rappelant le n° du chapitre: par exemple, préférer "II-19" plutôt que "19"

actif

protected boolean actif

Vrai si la règle est active dans la configuration

peda

protected boolean peda

Vrai si la règle est une règle pédagogique (non nécessaire dans la norme) dans la configuration

Constructor Detail

Regle

public Regle(java.lang.String d,
             java.lang.String ref,
             boolean a)

Parameters:

d - la description de la règle

ref - la référence de la règle

a - true si règle active

Regle

public Regle(java.lang.String d,
             java.lang.String ref,
             boolean a,
             boolean p)

Parameters:

d - la description de la règle

ref - la référence de la règle

a - true si règle active

p - true si règle pédagogique

Regle

public Regle(java.lang.String d,
             java.lang.String ref)

Parameters:

d - la description de la règle

ref - la référence de la règle

Method Detail

toString

public abstract java.lang.String toString()

Pour obliger la redéfinition de toString() de la Classe Object

Overrides:

toString in class java.lang.Object

Returns:

une chaine représentant la règle

equals

public abstract boolean equals(java.lang.Object o)

Vérifie si deux règles sont identiques

Overrides:

equals in class java.lang.Object

Parameters:

o - instance d'Object à comparer

Returns:

vrai si les règles sont identiques

getXML

public abstract java.lang.String getXML()

Renvoie un noeud xml sous forme de chaine représentant la règle

Returns:

une chaine xml représentant la règle

setActif

public void setActif(boolean a)

Parameters:

a - valeur pour #actif

isActif

public boolean isActif()

Returns:

valeur de #actif

isPeda

public boolean isPeda()

Returns:

valeur de peda

setPeda

public void setPeda(boolean p)

Parameters:

p - valeur pour peda