Interface NTxEngine

public interface NTxEngine

Author:

vpc

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CURRENT_VERSION
static final String	FILE_DOT_EXT
static final String	FILE_EXT

Method Summary

Modifier and Type	Method	Description
void	addDependencyLoadedListener(NTxDependencyLoadedListener listener)
NTxLogger	addLog(NTxLogger messages)
NTxCompiledDocument	asCompiledDocument(NTxDocument of)
void	compileNode(NTxNode node, NTxDocument document, NTxCompiledDocument compiledDocument, NTxCompiledPage compiledPage, NTxResolutionContext context, CompileNodeVisitor visitor)
void	compileNode(NTxResolutionContext ctx, CompileNodeVisitor visitor)
List<NTxStyleRule>	computeDeclaredStyles(NTxNode node)
Set<String>	computeDeclaredStylesClasses(NTxNode node)
<T> net.thevpc.nuts.util.NOptional<T>	computeIfAbsent(String name, Function<String,T> fct)
List<NTxProp>	computeInheritedProperties(NTxNode node)
List<NTxProp>	computeProperties(NTxNode node)
net.thevpc.nuts.util.NOptional<NTxProp>	computeProperty(NTxNode node, String... propertyNames)
<T> net.thevpc.nuts.util.NOptional<T>	computePropertyValue(NTxNode node, String... propertyNames)
List<NTxStyleRule>	computeStyles(NTxNode node)
NTxFunctionCallContext	createFunctionArgs(String functionName, net.thevpc.nuts.elem.NElement[] callArgs, NTxResolutionContext context)
NTxGraphics	createGraphics(Graphics2D g2d)
void	createProject(net.thevpc.nuts.io.NPath path, net.thevpc.nuts.io.NPath templateUrl, Function<String,String> vars)
void	defaultCompileNodeChildren(NTxNode node, NTxResolutionContext context)
void	defaultCompileNodeProperties(NTxNode node, NTxResolutionContext context)
NTxDocumentFactory	documentFactory()
void	dump()
void	dump(Consumer<net.thevpc.nuts.text.NMsg> out)
net.thevpc.nuts.util.NOptional<NTxFunction>	findFunction(String name)
net.thevpc.nuts.util.NOptional<NTxNode>	findNodeByProperty(String propertyName, Predicate<net.thevpc.nuts.elem.NElement> propertyValueFilter, NTxResolutionContext context)	Resolves a node within the document tree using an Ancestral-First Radial Search.
String	getAuthorEmail()
KeyPair	getAuthorKey()
String	getAuthorName()
String	getAuthorOrcid()
String	getAuthorUrl()
List<NTxStyleRule>	getDefaultStyles()
net.thevpc.nuts.reflect.NMutableClassLoader	getEngineClassLoader()
<T> net.thevpc.nuts.util.NOptional<T>	getEnv(String name)
net.thevpc.nuts.util.NOptional<NTxNodeRenderer>	getRenderer(String type)
NTxTemplateInfo[]	getTemplates()
List<NTxImageTypeRendererFactory>	imageTypeRendererFactories()
ImportDependencyResults	importDefaultDependencies()
ImportDependencyResults	importDependencies(String... deps)
boolean	isNtxProject(net.thevpc.nuts.io.NPath path)
NTxItemParser	itemParser()
NTxCompiledDocument	loadDocument(InputStream is)
NTxCompiledDocument	loadDocument(net.thevpc.nuts.io.NPath of)
net.thevpc.nuts.util.NOptional<NTxItem>	loadNode(NTxNode into, net.thevpc.nuts.io.NPath of, NTxCompiledDocument document)
<S> List<S>	loadServices(Class<S> serviceClass)
NTxLogger	log()
NTxResolutionContext	newContext(NTxNode node, NTxDocument document, NTxCompiledDocument compiledDocument, NTxCompiledPage compiledPage, NTxResolutionContext parentContext)
NTxNode	newDefaultNode(String id)
net.thevpc.nuts.util.NOptional<NTxDocumentStreamRenderer>	newHtmlRenderer()
net.thevpc.nuts.util.NOptional<NTxDocumentStreamRenderer>	newImageRenderer()
net.thevpc.nuts.util.NOptional<NTxDocumentStreamRenderer>	newPdfRenderer()
net.thevpc.nuts.util.NOptional<NTxDocumentRenderer>	newRenderer(String type)
net.thevpc.nuts.util.NOptional<NTxDocumentScreenRenderer>	newScreenRenderer()
net.thevpc.nuts.util.NOptional<NTxDocumentStreamRenderer>	newStreamRenderer(String type)
List<NTxNodeParser>	nodeTypeFactories()
net.thevpc.nuts.util.NOptional<NTxNodeParser>	nodeTypeParser(String id)
NTxEngine	parseNode(net.thevpc.nuts.elem.NElement element, NTxResolutionContext ctx, Consumer<net.thevpc.nuts.util.NOptional<NTxItem>> consumer)
NTxLogger	removeLog(NTxLogger messages)
BufferedImage	renderImage(NTxCompiledPage page, NTxNodeRendererConfig config)
byte[]	renderImageBytes(NTxCompiledPage page, NTxNodeRendererConfig config)
void	renderPage(NTxCompiledPage page, NTxNodeRendererConfig config, Graphics2D g, ImageObserver imageObserver, Runnable repainter)
NTxEngine	setAuthorEmail(String authorEmail)
NTxEngine	setAuthorKey(KeyPair authorPublicKey)
NTxEngine	setAuthorName(String authorName)
NTxEngine	setAuthorUrl(String authorUrl)
NTxEngine	setEnv(String env, Object value)
net.thevpc.nuts.util.NOptional<NTxTextRendererFlavor>	textRendererFlavor(String id)
List<NTxTextRendererFlavor>	textRendererFlavors()
net.thevpc.nuts.elem.NElement	toElement(NTxNode node, boolean semantic)
net.thevpc.nuts.elem.NElement	toElement(NTxDocument doc, boolean semantic)
NTxEngineTools	tools()
boolean	validateNode(NTxNode node)

Field Details

CURRENT_VERSION

static final String CURRENT_VERSION

See Also:

• Constant Field Values

FILE_EXT

static final String FILE_EXT

See Also:

• Constant Field Values

FILE_DOT_EXT

static final String FILE_DOT_EXT

See Also:

• Constant Field Values

Method Details

log

NTxLogger log()

imageTypeRendererFactories

List<NTxImageTypeRendererFactory> imageTypeRendererFactories()

importDefaultDependencies

ImportDependencyResults importDefaultDependencies()

importDependencies

ImportDependencyResults importDependencies(String... deps)

getEngineClassLoader

net.thevpc.nuts.reflect.NMutableClassLoader getEngineClassLoader()

loadServices

<S> List<S> loadServices(Class<S> serviceClass)

addDependencyLoadedListener

void addDependencyLoadedListener(NTxDependencyLoadedListener listener)

dump

void dump()

dump

void dump(Consumer<net.thevpc.nuts.text.NMsg> out)

tools

NTxEngineTools tools()

addLog

NTxLogger addLog(NTxLogger messages)

findFunction

net.thevpc.nuts.util.NOptional<NTxFunction> findFunction(String name)

removeLog

NTxLogger removeLog(NTxLogger messages)

nodeTypeFactories

List<NTxNodeParser> nodeTypeFactories()

itemParser

NTxItemParser itemParser()

newDefaultNode

NTxNode newDefaultNode(String id)

nodeTypeParser

net.thevpc.nuts.util.NOptional<NTxNodeParser> nodeTypeParser(String id)

documentFactory

NTxDocumentFactory documentFactory()

parseNode

NTxEngine parseNode(net.thevpc.nuts.elem.NElement element,
 NTxResolutionContext ctx,
 Consumer<net.thevpc.nuts.util.NOptional<NTxItem>> consumer)

newStreamRenderer

net.thevpc.nuts.util.NOptional<NTxDocumentStreamRenderer> newStreamRenderer(String type)

newPdfRenderer

net.thevpc.nuts.util.NOptional<NTxDocumentStreamRenderer> newPdfRenderer()

newHtmlRenderer

net.thevpc.nuts.util.NOptional<NTxDocumentStreamRenderer> newHtmlRenderer()

newImageRenderer

net.thevpc.nuts.util.NOptional<NTxDocumentStreamRenderer> newImageRenderer()

newScreenRenderer

net.thevpc.nuts.util.NOptional<NTxDocumentScreenRenderer> newScreenRenderer()

newRenderer

net.thevpc.nuts.util.NOptional<NTxDocumentRenderer> newRenderer(String type)

newContext

NTxResolutionContext newContext(NTxNode node,
 NTxDocument document,
 NTxCompiledDocument compiledDocument,
 NTxCompiledPage compiledPage,
 NTxResolutionContext parentContext)

validateNode

boolean validateNode(NTxNode node)

loadDocument

NTxCompiledDocument loadDocument(net.thevpc.nuts.io.NPath of)

asCompiledDocument

NTxCompiledDocument asCompiledDocument(NTxDocument of)

loadNode

net.thevpc.nuts.util.NOptional<NTxItem> loadNode(NTxNode into,
 net.thevpc.nuts.io.NPath of,
 NTxCompiledDocument document)

loadDocument

NTxCompiledDocument loadDocument(InputStream is)

toElement

net.thevpc.nuts.elem.NElement toElement(NTxDocument doc,
 boolean semantic)

toElement

net.thevpc.nuts.elem.NElement toElement(NTxNode node,
 boolean semantic)

computeProperty

net.thevpc.nuts.util.NOptional<NTxProp> computeProperty(NTxNode node,
 String... propertyNames)

computeStyles

List<NTxStyleRule> computeStyles(NTxNode node)

computeDeclaredStyles

List<NTxStyleRule> computeDeclaredStyles(NTxNode node)

computeDeclaredStylesClasses

Set<String> computeDeclaredStylesClasses(NTxNode node)

computeInheritedProperties

List<NTxProp> computeInheritedProperties(NTxNode node)

computeProperties

List<NTxProp> computeProperties(NTxNode node)

computePropertyValue

<T> net.thevpc.nuts.util.NOptional<T> computePropertyValue(NTxNode node,
 String... propertyNames)

createGraphics

NTxGraphics createGraphics(Graphics2D g2d)

isNtxProject

boolean isNtxProject(net.thevpc.nuts.io.NPath path)

createProject

void createProject(net.thevpc.nuts.io.NPath path,
 net.thevpc.nuts.io.NPath templateUrl,
 Function<String,String> vars)

getTemplates

NTxTemplateInfo[] getTemplates()

textRendererFlavor

net.thevpc.nuts.util.NOptional<NTxTextRendererFlavor> textRendererFlavor(String id)

textRendererFlavors

List<NTxTextRendererFlavor> textRendererFlavors()

renderImage

BufferedImage renderImage(NTxCompiledPage page,
 NTxNodeRendererConfig config)

renderPage

void renderPage(NTxCompiledPage page,
 NTxNodeRendererConfig config,
 Graphics2D g,
 ImageObserver imageObserver,
 Runnable repainter)

renderImageBytes

byte[] renderImageBytes(NTxCompiledPage page,
 NTxNodeRendererConfig config)

getRenderer

net.thevpc.nuts.util.NOptional<NTxNodeRenderer> getRenderer(String type)

setAuthorKey

NTxEngine setAuthorKey(KeyPair authorPublicKey)

getEnv

<T> net.thevpc.nuts.util.NOptional<T> getEnv(String name)

computeIfAbsent

<T> net.thevpc.nuts.util.NOptional<T> computeIfAbsent(String name,
 Function<String,T> fct)

getDefaultStyles

List<NTxStyleRule> getDefaultStyles()

setEnv

NTxEngine setEnv(String env,
 Object value)

compileNode

void compileNode(NTxNode node,
 NTxDocument document,
 NTxCompiledDocument compiledDocument,
 NTxCompiledPage compiledPage,
 NTxResolutionContext context,
 CompileNodeVisitor visitor)

compileNode

void compileNode(NTxResolutionContext ctx,
 CompileNodeVisitor visitor)

defaultCompileNodeProperties

void defaultCompileNodeProperties(NTxNode node,
 NTxResolutionContext context)

defaultCompileNodeChildren

void defaultCompileNodeChildren(NTxNode node,
 NTxResolutionContext context)

findNodeByProperty

net.thevpc.nuts.util.NOptional<NTxNode> findNodeByProperty(String propertyName,
 Predicate<net.thevpc.nuts.elem.NElement> propertyValueFilter,
 NTxResolutionContext context)

Resolves a node within the document tree using an Ancestral-First Radial Search.

This resolution strategy is designed for document-centric architectures (NTexUp) where visual and hierarchical proximity dictates logical relationships. It prioritizes the direct lineage of the node before expanding to siblings and distant branches.

* The Search Protocol:

1. Phase 1: Ancestral Spine (The "Climb"): Traverses vertically from the startNode to the root. Only nodes on this direct path are checked. This facilitates "Property Inheritance," where a parent can provide a configuration override for its entire subtree.
2. Phase 2: Radial Expansion (The "Ripple"): If the spine yields no results, the search re-initiates from the startNode and moves upward. At each level, it performs a Deep-Scan (DFS) of all sibling subtrees. Branches already processed in previous steps are skipped to ensure each node is visited only once.

* Performance invalid input: '&' Soundness:

• Complexity: O(N), where N is the total number of nodes in the document tree.
• Determinism: The search is deterministic and respects "Scoped Shadowing," ensuring that local definitions in the same branch are found before global ones of the same name.
• Fail-Never: Returns a NOptional.ofNamedEmpty(String) if no match is found, allowing the compiler to continue execution for logging or UI hints.

* @param propertyName The property key to evaluate (e.g., "name" or "id").

Parameters:

propertyValueFilter - A predicate to validate the property value (e.g., matching a specific ID).

Returns:

An NOptional containing the first matching NTxNode, or a named empty optional if the search is exhausted.

createFunctionArgs

NTxFunctionCallContext createFunctionArgs(String functionName,
 net.thevpc.nuts.elem.NElement[] callArgs,
 NTxResolutionContext context)

setAuthorEmail

NTxEngine setAuthorEmail(String authorEmail)

getAuthorName

String getAuthorName()

getAuthorEmail

String getAuthorEmail()

setAuthorName

NTxEngine setAuthorName(String authorName)

getAuthorUrl

String getAuthorUrl()

getAuthorOrcid

String getAuthorOrcid()

setAuthorUrl

NTxEngine setAuthorUrl(String authorUrl)

getAuthorKey

KeyPair getAuthorKey()