Package com.isode.dsapi.bulk

Class SubstitutionSpecification

java.lang.Object

com.isode.dsapi.bulk.SubstitutionSpecification

public class SubstitutionSpecification
extends Object

This class provides a specification of how attribute values should be substituted when LDIF data is being loaded into the DSA.

Author:

tc

Constructor Summary

Constructors

Constructor	Description
SubstitutionSpecification(String filename)	Generate a new SubstitutionSpecification by reading a file.

Method Summary

Modifier and Type	Method	Description
List<SubstitutionData>	findByName(String name)	Find the substitution data for a given attribute type.
List<SubstitutionData>	findBySyntax(int syntax)	Find the substitution data for a given syntax.
void	parse(InputStream xmlStream)	Parse the xml stream to extract the substitution specifications

Methods inherited from class java.lang.Object

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

Constructor Details

SubstitutionSpecification

public SubstitutionSpecification(String filename)
                          throws FileNotFoundException,
SubstitutionException

Generate a new SubstitutionSpecification by reading a file.

Parameters:

filename - file to read

Throws:

FileNotFoundException

SubstitutionException

Method Details

findByName

public List<SubstitutionData> findByName(String name)

Find the substitution data for a given attribute type.

Parameters:

name - Name of attribute type

Returns:

SubsititutionData, which may be null

findBySyntax

public List<SubstitutionData> findBySyntax(int syntax)

Find the substitution data for a given syntax.

Parameters:

syntax - identifier for syntax type

Returns:

SubsititutionData, which may be null

parse

public void parse(InputStream xmlStream)
           throws SubstitutionException

Parse the xml stream to extract the substitution specifications

Parameters:

xmlStream - input stream pointing to xml

Throws:

SubstitutionException - if there is an error while parsing the XML