| Package | Description |
|---|---|
| org.quattor.pan.dml |
Provides high-level interface and abstract classes for DML (data manipulation language) processing.
|
| org.quattor.pan.dml.data |
Provides data elements for the Data Manipulation Language (DML).
|
| org.quattor.pan.dml.functions |
Includes classes that implement all of the pan language build-in functions.
|
| org.quattor.pan.dml.operators |
Contains classes that implement all of the pan language operators.
|
| org.quattor.pan.exceptions |
Exceptions that can be generated at various stages in the machine profile
processing.
|
| org.quattor.pan.output |
Implementation of output formatters for the generated machine profiles.
|
| org.quattor.pan.statement |
Provides classes that implement the core declarative statements of the
pan language.
|
| org.quattor.pan.tasks |
Provides classes that implement parallel tasks within the compiler.
|
| org.quattor.pan.template |
Contains the classes that define the java implementation a pan template
or classes related to them.
|
| org.quattor.pan.type |
Implements the pan type system.
|
| org.quattor.pan.utils |
Provides collection of useful utilities that don't fit neatly into other
pan packages.
|
| Modifier and Type | Method and Description |
|---|---|
protected Element[] |
AbstractOperation.calculateArgs(Context context)
A utility method which calls
execute on each of this
operation's arguments and returns an array of the results. |
Element |
DML.execute(Context context)
Execution of a DML block consists simply of executing the block's
arguments in order.
|
abstract Element |
AbstractOperation.execute(Context context) |
Element |
Operation.execute(Context context)
Execute this operation within the given context.
|
| Modifier and Type | Class and Description |
|---|---|
class |
BooleanProperty
Represents a boolean value.
|
class |
DoubleProperty
Represents a double value.
|
class |
HashResource
Represents an dict (nlist or hash) that associates a string value (key) to
another element.
|
class |
ListResource
Represents an ordered list of elements.
|
class |
LongProperty
Represents a long value.
|
class |
Null
Represents a null value in the pan language.
|
class |
NumberProperty
Implements a superclass for all primitive pan numbers (long and double).
|
class |
PersistentElement
Subclasses of this abstract class can appear as valid elements in a generated
configuration tree (hence can be made persistent).
|
class |
Property
Property represents a simple primitive type (boolean, long, or string) in the
pan language.
|
class |
ProtectedHashResource |
class |
ProtectedListResource |
class |
Resource
A Resource is a container of Properties and other Resources.
|
class |
StringProperty
Represents a string value.
|
class |
TransientElement
Subclasses of this abstract class may not appear in a final configuration
tree.
|
class |
Undef
Represents the undef value in the pan language.
|
| Modifier and Type | Method and Description |
|---|---|
Element |
ProtectedHashResource.duplicate() |
Element |
ProtectedListResource.duplicate() |
Element |
ListResource.duplicate() |
Element |
HashResource.duplicate() |
Element |
Element.duplicate()
This method does a "clone" of the given Element.
|
Element |
Element.execute(Context context)
All Elements are Operations and can be executed, but each just returns a
reference to itself.
|
Element |
ProtectedHashResource.get(Term key) |
Element |
ProtectedListResource.get(Term key) |
Element |
ListResource.get(Term term) |
abstract Element |
Resource.get(Term term)
Retrieve the Element associated with the given Term (either an index or
string key).
|
Element |
HashResource.get(Term term) |
Element |
ProtectedHashResource.protect() |
Element |
ProtectedListResource.protect() |
Element |
ListResource.protect() |
Element |
HashResource.protect() |
Element |
Element.protect()
Return a protected version of this Element.
|
Element |
ProtectedListResource.put(int index,
Element newValue) |
Element |
ListResource.put(int index,
Element newValue)
This is an optimized version of the put method which doesn't require
creating a Term object.
|
Element |
ProtectedHashResource.put(Term key,
Element newValue) |
Element |
ProtectedListResource.put(Term key,
Element newValue) |
Element |
ListResource.put(Term term,
Element value) |
abstract Element |
Resource.put(Term term,
Element newValue)
Define the mapping between the given Term and given Element.
|
Element |
HashResource.put(Term term,
Element newValue) |
Element |
Resource.rget(Term[] terms,
int index,
boolean protect,
boolean lookupOnly) |
Element |
Element.rget(Term[] terms,
int index,
boolean protect,
boolean lookupOnly)
Dereference the Element to return the value of a child.
|
Element |
ProtectedHashResource.writableCopy() |
Element |
ProtectedListResource.writableCopy() |
Element |
Element.writableCopy()
This method returns a writable copy of this Element.
|
| Modifier and Type | Method and Description |
|---|---|
protected List<Element> |
ProtectedListResource.getBackingList()
Override this method to return the list from the base list.
|
protected List<Element> |
ListResource.getBackingList()
This method is used to access the underlying map used to store the hash
information.
|
protected Map<String,Element> |
ProtectedHashResource.getBackingMap()
Override this method to return the map from the base hash.
|
protected Map<String,Element> |
HashResource.getBackingMap()
This method is used to access the underlying map used to store the hash
information.
|
| Modifier and Type | Method and Description |
|---|---|
void |
ListResource.append(Element e)
Specialized method for a ListResource to append an element to the end of
the list.
|
void |
Undef.checkValidReplacement(Element newValue) |
void |
Null.checkValidReplacement(Element newValue) |
void |
ListResource.checkValidReplacement(Element newValue) |
void |
HashResource.checkValidReplacement(Element newValue) |
void |
Element.checkValidReplacement(Element newValue)
Check that the newValue is a valid replacement for the this value.
|
void |
ListResource.prepend(Element e)
Specialized method for a ListResource to prepend an element at the
beginning of a list.
|
Element |
ProtectedListResource.put(int index,
Element newValue) |
Element |
ListResource.put(int index,
Element newValue)
This is an optimized version of the put method which doesn't require
creating a Term object.
|
Element |
ProtectedHashResource.put(Term key,
Element newValue) |
Element |
ProtectedListResource.put(Term key,
Element newValue) |
Element |
ListResource.put(Term term,
Element value) |
abstract Element |
Resource.put(Term term,
Element newValue)
Define the mapping between the given Term and given Element.
|
Element |
HashResource.put(Term term,
Element newValue) |
void |
ProtectedHashResource.rput(Term[] terms,
int index,
Element value) |
void |
ProtectedListResource.rput(Term[] terms,
int index,
Element value) |
void |
Resource.rput(Term[] terms,
int index,
Element value) |
void |
Element.rput(Term[] terms,
int index,
Element value)
Add the given child to this resource, creating intermediate resources as
necessary.
|
| Constructor and Description |
|---|
ListResource(Element[] args) |
| Modifier and Type | Field and Description |
|---|---|
protected Class<? extends Element> |
IsOfType.type |
| Modifier and Type | Method and Description |
|---|---|
Element |
ToBoolean.execute(Context context) |
Element |
Create.execute(Context context) |
Element |
First.execute(Context context) |
Element |
IsVariableOfType.execute(Context context) |
Element |
StaticMatch.execute(Context context) |
Element |
TracebackSuppressed.execute(Context context) |
Element |
Key.execute(Context context) |
Element |
Matches.execute(Context context) |
Element |
ToUpperCase.execute(Context context) |
Element |
Value.execute(Context context) |
Element |
VariableExists.execute(Context context) |
Element |
IfExists.execute(Context context) |
Element |
Substr.execute(Context context) |
Element |
Merge.execute(Context context) |
Element |
List.execute(Context context) |
Element |
Index.execute(Context context) |
Element |
Append.execute(Context context) |
Element |
Unescape.execute(Context context) |
Element |
Base64Encode.execute(Context context) |
Element |
Traceback.execute(Context context) |
Element |
Match.execute(Context context) |
Element |
ErrorMessage.execute(Context context) |
Element |
Base64Decode.execute(Context context) |
Element |
FileContents.execute(Context context) |
Element |
Digest.execute(Context context) |
Element |
ToString.execute(Context context) |
Element |
Return.execute(Context context) |
Element |
Function.execute(Context context) |
Element |
Next.execute(Context context) |
Element |
DebugSuppressed.execute(Context context) |
Element |
Deprecated.execute(Context context) |
Element |
Prepend.execute(Context context) |
Element |
ToLong.execute(Context context) |
Element |
Length.execute(Context context) |
Element |
ToDouble.execute(Context context) |
Element |
PathExists.execute(Context context) |
Element |
Replace.execute(Context context) |
Element |
FileExists.execute(Context context) |
Element |
Debug.execute(Context context) |
Element |
ToLowerCase.execute(Context context) |
Element |
Split.execute(Context context) |
Element |
Splice.execute(Context context) |
Element |
Format.execute(Context context) |
Element |
Escape.execute(Context context) |
Element |
StaticMatches.execute(Context context) |
Element |
Substitute.execute(Context context) |
Element |
IpToLong.execute(Context context) |
Element |
ToLongRadix.execute(Context context) |
Element |
StringExists.execute(Context context) |
Element |
LongToIp.execute(Context context) |
Element |
IsValueOfType.execute(Context context) |
Element |
Delete.execute(Context context) |
Element |
Hash.execute(Context context) |
Element |
Clone.execute(Context context) |
| Modifier and Type | Method and Description |
|---|---|
protected Pattern |
AbstractMatcher.compilePattern(Element regex,
int flags)
Generate a Pattern from the given string and flags.
|
protected int |
AbstractMatcher.convertMatchFlags(Element opts)
A utility function to convert a string containing match options to the
associated integer with the appropriate bits set.
|
| Modifier and Type | Method and Description |
|---|---|
static Operation |
IsVariableOfType.getInstance(SourceRange sourceRange,
Class<? extends Element> type,
String name,
Operation... operations) |
static Operation |
IsOfType.getInstance(SourceRange sourceRange,
Class<? extends Element> type,
String name,
Operation... operations) |
static Operation |
IsValueOfType.getInstance(SourceRange sourceRange,
Class<? extends Element> type,
String name,
Operation... operations) |
| Constructor and Description |
|---|
IsOfType(String name,
SourceRange sourceRange,
Class<? extends Element> type,
Operation... operations) |
| Modifier and Type | Method and Description |
|---|---|
static Element |
LogicalNot.execute(BooleanProperty a) |
Element |
LogicalAnd.execute(Context context) |
Element |
BitAnd.execute(Context context) |
Element |
LogicalGE.execute(Context context) |
Element |
LogicalNot.execute(Context context) |
Element |
LogicalLE.execute(Context context) |
Element |
LogicalGT.execute(Context context) |
Element |
SelfSimpleVariable.execute(Context context) |
Element |
SimpleVariable.execute(Context context) |
Element |
Mult.execute(Context context) |
Element |
LogicalOr.execute(Context context) |
Element |
UnaryPlus.execute(Context context) |
Element |
IfElse.execute(Context context)
Perform the if statement.
|
Element |
Add.execute(Context context)
Perform the addition of the two top values on the data stack in the given
DMLContext.
|
Element |
LogicalNE.execute(Context context) |
Element |
While.execute(Context context) |
Element |
For.execute(Context context) |
Element |
Assign.execute(Context context) |
Element |
Div.execute(Context context) |
Element |
SelfNestedVariable.execute(Context context) |
Element |
SelfSimpleListVariable.execute(Context context) |
Element |
BitIOR.execute(Context context) |
Element |
LogicalEQ.execute(Context context) |
Element |
BitXOR.execute(Context context) |
Element |
Foreach.execute(Context context) |
Element |
NestedVariable.execute(Context context) |
Element |
UnaryMinus.execute(Context context) |
Element |
LogicalLT.execute(Context context) |
Element |
NestedListVariable.execute(Context context) |
Element |
SelfNestedListVariable.execute(Context context) |
Element |
Mod.execute(Context context) |
Element |
SimpleListVariable.execute(Context context) |
Element |
Sub.execute(Context context) |
Element |
SetValue.execute(Context context) |
Element |
SetSelf.execute(Context context) |
Element |
BitNot.execute(Context context) |
Element |
SetValue.execute(Context context,
Element result) |
Element |
SetSelf.execute(Context context,
Element result) |
static Element |
BitXOR.execute(LongProperty a,
LongProperty b) |
static Element |
Sub.execute(NumberProperty a,
NumberProperty b) |
static Element |
Mod.execute(SourceRange sourceRange,
LongProperty a,
LongProperty b) |
| Modifier and Type | Method and Description |
|---|---|
Element |
SetValue.execute(Context context,
Element result) |
Element |
SetSelf.execute(Context context,
Element result) |
| Modifier and Type | Method and Description |
|---|---|
Element |
ReturnValueException.getElement() |
| Constructor and Description |
|---|
ReturnValueException(Element element) |
| Modifier and Type | Method and Description |
|---|---|
void |
PanTxtFormatter.readChild(Element element,
PrintWriter ps,
int level,
String name)
Reads each child.
|
abstract void |
PanTxtFormatter.write(Element root,
String rootName,
PrintWriter ps)
Reads the configuration tree and writes it in an xml file.
|
void |
TxtFormatter.write(Element root,
String rootname,
PrintWriter ps) |
| Modifier and Type | Field and Description |
|---|---|
protected Element |
ConstantAssignmentStatement.value |
protected Element |
ConstantVariableStatement.value |
| Modifier and Type | Method and Description |
|---|---|
static List<String> |
VariableStatement.convertLoadpathVariable(Element element)
Convert the given element (which should be the "LOADPATH" global
variable) to a list of strings.
|
static AssignmentStatement |
AssignmentStatement.createAssignmentStatement(SourceRange sourceRange,
Path path,
Element value,
boolean conditional,
boolean modifiable) |
| Constructor and Description |
|---|
ConstantAssignmentStatement(SourceRange sourceRange,
Path path,
Element value,
boolean conditional,
boolean modifiable)
This constructor creates a new AbsoluteAssignmentStatement that assigns a
constant value (Element) to the associated path.
|
ConstantLoadpathStatement(SourceRange sourceRange,
Element value,
boolean conditional,
boolean modifiable) |
ConstantVariableStatement(SourceRange sourceRange,
String name,
Element value,
boolean conditional,
boolean modifiable) |
| Modifier and Type | Method and Description |
|---|---|
Element |
BuildResult.getRoot() |
Element |
Valid2Result.getRoot() |
Element |
FinalResult.getRoot() |
| Constructor and Description |
|---|
BuildResult(Element root,
Context context) |
Valid1Result(Element root,
Context context) |
Valid2Result(String objectName,
Element root,
Set<String> objectDependencies,
Set<SourceFile> dependencies) |
| Modifier and Type | Field and Description |
|---|---|
protected Element |
SelfHolder.element |
| Modifier and Type | Method and Description |
|---|---|
Element |
CompileTimeContext.dereferenceVariable(String name,
boolean lookupOnly,
Term[] terms)
Return the Element which corresponds to the given variable name.
|
Element |
BuildContext.dereferenceVariable(String name,
boolean lookupOnly,
Term[] terms)
Return the Element which corresponds to the given variable name.
|
Element |
Context.dereferenceVariable(String name,
boolean lookupOnly,
Term[] terms)
Return the Element which corresponds to the given variable name.
|
Element |
CompileTimeContext.executeDmlBlock(Operation dml) |
Element |
BuildContext.executeDmlBlock(Operation dml) |
Element |
Context.executeDmlBlock(Operation dml) |
Element |
LocalVariableMap.get(String name)
Lookup the value associated with the given variable name.
|
Element |
InvalidSelfHolder.getElement() |
Element |
SelfHolder.getElement() |
Element |
CompileTimeContext.getElement(Path path)
Pull the value of an element from a configuration tree.
|
Element |
BuildContext.getElement(Path path)
Pull the value of an element from a configuration tree.
|
Element |
Context.getElement(Path path)
Pull the value of an element from a configuration tree.
|
Element |
CompileTimeContext.getElement(Path path,
boolean errorIfNotFound)
Pull the value of an element from a configuration tree.
|
Element |
BuildContext.getElement(Path path,
boolean errorIfNotFound)
Pull the value of an element from a configuration tree.
|
Element |
Context.getElement(Path path,
boolean errorIfNotFound)
Pull the value of an element from a configuration tree.
|
Element |
CompileTimeContext.getGlobalVariable(String name)
Return the Element which corresponds to the given variable name without
duplicating the value.
|
Element |
BuildContext.getGlobalVariable(String name)
Return the Element which corresponds to the given variable name without
duplicating the value.
|
Element |
Context.getGlobalVariable(String name)
Return the Element which corresponds to the given variable name without
duplicating the value.
|
Element |
CompileTimeContext.getLocalVariable(String name)
Return the value associated with a local variable.
|
Element |
BuildContext.getLocalVariable(String name)
Return the value associated with a local variable.
|
Element |
Context.getLocalVariable(String name)
Return the value associated with a local variable.
|
Element |
CompileTimeContext.getSelf() |
Element |
BuildContext.getSelf() |
Element |
Context.getSelf() |
Element |
CompileTimeContext.getVariable(String name)
Return the Element which corresponds to the given variable name.
|
Element |
BuildContext.getVariable(String name)
Return the Element which corresponds to the given variable name.
|
Element |
Context.getVariable(String name)
Return the Element which corresponds to the given variable name.
|
Element |
LocalVariableMap.put(String name,
Element value)
Assign the value to the given variable name.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
CompileTimeContext.executeDmlValidationBlock(Operation dml,
Element self) |
boolean |
BuildContext.executeDmlValidationBlock(Operation dml,
Element self) |
boolean |
Context.executeDmlValidationBlock(Operation dml,
Element self) |
Element |
LocalVariableMap.put(String name,
Element value)
Assign the value to the given variable name.
|
void |
CompileTimeContext.putElement(Path path,
Element value) |
void |
BuildContext.putElement(Path path,
Element value) |
void |
Context.putElement(Path path,
Element value) |
GlobalVariable |
CompileTimeContext.replaceGlobalVariable(String name,
Element value,
boolean finalFlag)
Replaces the given global variable with the given value.
|
GlobalVariable |
BuildContext.replaceGlobalVariable(String name,
Element value,
boolean finalFlag)
Replaces the given global variable with the given value.
|
GlobalVariable |
Context.replaceGlobalVariable(String name,
Element value,
boolean finalFlag)
Replaces the given global variable with the given value.
|
void |
CompileTimeContext.resetSelf(Element newValue) |
void |
BuildContext.resetSelf(Element newValue) |
void |
Context.resetSelf(Element newValue) |
void |
InvalidSelfHolder.setElement(Element element) |
void |
ReadOnlySelfHolder.setElement(Element element) |
void |
PathSelfHolder.setElement(Element element) |
void |
VariableSelfHolder.setElement(Element element) |
void |
SelfHolder.setElement(Element element) |
void |
CompileTimeContext.setGlobalVariable(String name,
Element value)
Set the variable to the given value, preserving the status of the final
flag.
|
void |
BuildContext.setGlobalVariable(String name,
Element value)
Set the variable to the given value, preserving the status of the final
flag.
|
void |
Context.setGlobalVariable(String name,
Element value)
Set the variable to the given value, preserving the status of the final
flag.
|
void |
CompileTimeContext.setGlobalVariable(String name,
Element value,
boolean finalFlag)
Set the variable to the given value.
|
void |
BuildContext.setGlobalVariable(String name,
Element value,
boolean finalFlag)
Set the variable to the given value.
|
void |
Context.setGlobalVariable(String name,
Element value,
boolean finalFlag)
Set the variable to the given value.
|
void |
CompileTimeContext.setLocalVariable(String name,
Element value)
Set the local variable to the given value.
|
void |
BuildContext.setLocalVariable(String name,
Element value)
Set the local variable to the given value.
|
void |
Context.setLocalVariable(String name,
Element value)
Set the local variable to the given value.
|
void |
CompileTimeContext.setLocalVariable(String name,
Term[] terms,
Element value)
Set the local variable to the given value.
|
void |
BuildContext.setLocalVariable(String name,
Term[] terms,
Element value)
Set the local variable to the given value.
|
void |
Context.setLocalVariable(String name,
Term[] terms,
Element value)
Set the local variable to the given value.
|
| Constructor and Description |
|---|
ReadOnlySelfHolder(Element element) |
| Modifier and Type | Method and Description |
|---|---|
Element |
LinkType.findDefault(Context context) |
Element |
AliasType.findDefault(Context context) |
Element |
HashType.findDefault(Context context) |
Element |
PrimitiveType.findDefault(Context context) |
Element |
ListType.findDefault(Context context) |
Element |
RecordType.findDefault(Context context) |
abstract Element |
Type.findDefault(Context context)
This method returns the default value for the type or null if no default
value exists.
|
Element |
FullType.findDefault(Context context) |
Element |
LinkType.setDefaults(Context context,
Element self) |
Element |
AliasType.setDefaults(Context context,
Element self) |
Element |
HashType.setDefaults(Context context,
Element self) |
Element |
PrimitiveType.setDefaults(Context context,
Element self) |
Element |
ListType.setDefaults(Context context,
Element self) |
Element |
RecordType.setDefaults(Context context,
Element self) |
abstract Element |
Type.setDefaults(Context context,
Element self)
This method will recursively set the default values on the given element.
|
Element |
FullType.setDefaults(Context context,
Element self)
This will call the setDefaults method of the base type with the given
argument.
|
| Modifier and Type | Method and Description |
|---|---|
Element |
LinkType.setDefaults(Context context,
Element self) |
Element |
AliasType.setDefaults(Context context,
Element self) |
Element |
HashType.setDefaults(Context context,
Element self) |
Element |
PrimitiveType.setDefaults(Context context,
Element self) |
Element |
ListType.setDefaults(Context context,
Element self) |
Element |
RecordType.setDefaults(Context context,
Element self) |
abstract Element |
Type.setDefaults(Context context,
Element self)
This method will recursively set the default values on the given element.
|
Element |
FullType.setDefaults(Context context,
Element self)
This will call the setDefaults method of the base type with the given
argument.
|
void |
LinkType.validate(Context context,
Element self) |
void |
AliasType.validate(Context context,
Element self) |
void |
HashType.validate(Context context,
Element self) |
void |
ConcretePrimitiveType.validate(Context context,
Element self) |
void |
ListType.validate(Context context,
Element self) |
void |
RecordType.validate(Context context,
Element self) |
abstract void |
Type.validate(Context context,
Element self)
This method will run this type's validation against the given element.
|
void |
FullType.validate(Context context,
Element self) |
void |
RecordType.validateAsIncludedType(Context context,
Element self) |
void |
Type.validateAsIncludedType(Context context,
Element self)
This method will run this type's validation (as an included type) against
the given element.
|
void |
FullType.validateAsIncludedType(Context context,
Element self)
A FullType defers the validation to the referenced BaseType, but also
runs the DML validation block if defined.
|
| Constructor and Description |
|---|
FullType(String source,
SourceRange sourceRange,
BaseType baseType,
Element defaultValue,
Operation dml) |
| Constructor and Description |
|---|
ConcretePrimitiveType(String name,
Class<? extends Element> elementType) |
| Modifier and Type | Method and Description |
|---|---|
Element |
GlobalVariable.getUnprotectedValue() |
Element |
GlobalVariable.getValue() |
| Modifier and Type | Method and Description |
|---|---|
static Term |
TermFactory.create(Element element)
Create a term from a given element.
|
void |
GlobalVariable.setValue(Element newValue) |
| Constructor and Description |
|---|
GlobalVariable(boolean finalFlag,
Element value) |
Copyright © 2014 Quattor. All Rights Reserved.