org.silverpeas.search.indexEngine.model
Class FileDescription

java.lang.Object
  org.silverpeas.search.indexEngine.model.FileDescription

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

JcrContent

public class FileDescription
extends Object
implements Serializable

A FileDescription pack all the needed information to parse and index a file. We need :

• the path to the file
• the encoding of the file
• the format of the file
• the language of the file

The java.io.InputStreamReader javadoc page provides a link to a list of java-known encodings.

See Also:

Serialized Form

Constructor Summary

FileDescription(String path, String encoding, String format, String lang)
Set the new FileDescription with the given path, encoding, format and language.

Method Summary

boolean	equals(Object o)
String	getEncoding() Return the file encoding
String	getFormat() Return the file format
String	getLang() Return the file language
String	getPath() Return the file path
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

FileDescription

public FileDescription(String path,
                       String encoding,
                       String format,
                       String lang)

Set the new FileDescription with the given path, encoding, format and language. The path must not be null.

Parameters:

path -

encoding -

format -

lang -

Method Detail

getPath

public String getPath()

Return the file path

Returns:

getEncoding

public String getEncoding()

Return the file encoding

Returns:

getFormat

public String getFormat()

Return the file format

Returns:

getLang

public String getLang()

Return the file language

Returns:

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object