net.sf.xdc.processing
Class XPathPattern

java.lang.Object
  net.sf.xdc.processing.XPathPattern

public class XPathPattern

extends java.lang.Object

The class XPathPattern represents a link within a {@link} or a @see tag whose anchor section is an XPath expression.

Since:

0.5

Version:

0.5

Author:

Jens Voß

Constructor Summary

XPathPattern(java.lang.String file, java.lang.String pattern)
Public constructor.

Method Summary

java.lang.String	getFile() Getter method for this XPathPattern's file value (i.e. the constituent of the link before the double hash ('##')).
java.lang.String	getPattern() Getter method for this XPathPattern's pattern (i.e. the constituent of the link after the double hash ('##')).
java.lang.String	getTargetFile() Getter method for this XPathPattern's targetFile member.
java.lang.String	getValue() Getter method for this XPathPattern's value (i.e. the name of the anchor of the targetted element in the generated documentation page).
void	setTargetFile(java.lang.String targetFile) Setter method for this XPathPattern's targetFile member.
void	setValue(java.lang.String value) Setter method for this XPathPattern's value (i.e. the name of the anchor of the targetted element in the generated documentation page).

Methods inherited from class java.lang.Object

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

Constructor Detail

XPathPattern

public XPathPattern(java.lang.String file,
                    java.lang.String pattern)

Public constructor. Sets the file and the pattern members.

Parameters:

file - The file part of the link

pattern - The XPath expression making up the anchor section

Method Detail

setTargetFile

public void setTargetFile(java.lang.String targetFile)

Setter method for this XPathPattern's targetFile member.

Parameters:

targetFile - This XPathPattern's targetFile

setValue

public void setValue(java.lang.String value)

Setter method for this XPathPattern's value (i.e. the name of the anchor of the targetted element in the generated documentation page).

Parameters:

value - This XPathPattern' value

getFile

public java.lang.String getFile()

Getter method for this XPathPattern's file value (i.e. the constituent of the link before the double hash ('##')).

Returns:

This XPathPattern's file value

getPattern

public java.lang.String getPattern()

Getter method for this XPathPattern's pattern (i.e. the constituent of the link after the double hash ('##')).

Returns:

This XPathPattern's pattern.

getTargetFile

public java.lang.String getTargetFile()

Getter method for this XPathPattern's targetFile member.

Returns:

This XPathPattern's targetFile

getValue

public java.lang.String getValue()

Getter method for this XPathPattern's value (i.e. the name of the anchor of the targetted element in the generated documentation page).

Returns:

This XPathPattern' value