org.pageseeder.bridge.psml

Class PropertiesFragment

java.lang.Object

org.pageseeder.bridge.psml.FragmentBase

org.pageseeder.bridge.psml.PropertiesFragment

All Implemented Interfaces:

PSMLFragment, org.pageseeder.xmlwriter.XMLWritable

public class PropertiesFragment
extends FragmentBase
implements PSMLFragment

A PSML properties fragment.

Warning: this version only supports single value properties.

Version:

0.1.0

Author:

Christophe Lauret

Constructor Summary

Constructors

Constructor and Description
PropertiesFragment(String id) Creates a new properties fragment with the specified ID.
PropertiesFragment(String id, String type) Creates a new properties fragment with the specified ID and type.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Property p) Adds a property to the fragment.
List<Property>	getProperties()
Property	getProperty(String name) Returns the property for the specified name.
String	getPropertyValue(String name) Returns the property for the specified name.
void	set(Property property) Sets a property.
void	setProperty(String name, int value) Sets a property.
void	setProperty(String name, String value) Sets a property.
void	toXML(org.pageseeder.xmlwriter.XMLWriter psml)

Methods inherited from class org.pageseeder.bridge.psml.FragmentBase

id, toPSML, type

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pageseeder.bridge.psml.PSMLFragment

id, toPSML, type

Constructor Detail

PropertiesFragment

public PropertiesFragment(String id)

Creates a new properties fragment with the specified ID.

Parameters:

id - The fragment ID.

PropertiesFragment

public PropertiesFragment(String id,
                  String type)

Creates a new properties fragment with the specified ID and type.

Parameters:

id - The fragment ID.

type - the fragment type..

Method Detail

getProperty

public Property getProperty(String name)

Returns the property for the specified name.

Parameters:

name - the property name.

Returns:

the first property matching the specified name or null.

Throws:

NullPointerException - if the name if null

getProperties

public List<Property> getProperties()

Returns:

the actual list of properties in this fragment.

add

public void add(Property p)

Adds a property to the fragment.

Parameters:

p - The property to add.

set

public void set(Property property)

Sets a property.

Note: If multiple properties share the same name ALL of them are changed.

Parameters:

property - The property to set.

getPropertyValue

public String getPropertyValue(String name)

Returns the property for the specified name.

Parameters:

name - the property name.

Returns:

the value of the first property matching the specified name or null.

Throws:

NullPointerException - if the name if null

setProperty

public void setProperty(String name,
               String value)

Sets a property.

Note: If multiple properties share the same name ALL of them are changed.

If the property does not exist in the fragment nothing happens.

Parameters:

name - The name of the property to set.

value - The value of the property to set.

setProperty

public void setProperty(String name,
               int value)

Sets a property.

Note: If multiple properties share the same name ALL of them are changed.

If the property does not exist in the fragment nothing happens.

Parameters:

name - The name of the property to set.

value - The value of the property to set.

toXML

public void toXML(org.pageseeder.xmlwriter.XMLWriter psml)
           throws IOException

Specified by:

toXML in interface org.pageseeder.xmlwriter.XMLWritable

Throws:

IOException