com.stratelia.silverpeas.classifyEngine
Class ClassifyEngine

java.lang.Object
  com.stratelia.silverpeas.classifyEngine.ClassifyEngine

All Implemented Interfaces:

Cloneable

public class ClassifyEngine
extends Object
implements Cloneable

This class represents the ClassifyEngine API It gives access to functions for classifying, unclassifying and searching SilverObjetIds Assumption : The SilverObjetIds processed are int values from 0 to n The axis processed are int values from 0 to n

Constructor Summary

ClassifyEngine()

Method Summary

int	classifySilverObject(Connection connection, int silverObjectId, Position position)
static void	clearCache()
List<Position>	findPositionsBySilverOjectId(int nSilverObjectId)
List<Integer>	findSilverOjectByCriterias(List<Criteria> alGivenCriterias, JoinStatement joinStatementContainer, JoinStatement joinStatementContent, String afterDate, String beforeDate)
List<Integer>	findSilverOjectByCriterias(List<Criteria> alGivenCriterias, JoinStatement joinStatementContainer, JoinStatement joinStatementContent, String afterDate, String beforeDate, boolean recursiveSearch, boolean visibilitySensitive)
static int	getMaxAxis()
List<ObjectValuePair>	getObjectValuePairsByJoin(List<? extends Criteria> alGivenCriterias, int nLogicalAxisId, JoinStatement joinStatementAllPositions)
List<PertinentAxis>	getPertinentAxis(List<? extends Criteria> alGivenCriterias, List<Integer> alAxisIds)
List<Integer>	getPertinentAxisByInstanceIds(List<String> instanceIds) Get axis on which some informations are classified according to given list
List<PertinentAxis>	getPertinentAxisByJoin(List<? extends Criteria> alGivenCriterias, List<Integer> alAxisIds, JoinStatement joinStatementAllPositions)
List<PertinentValue>	getPertinentValues(List<? extends Criteria> alGivenCriterias, int nLogicalAxisId)
List<PertinentValue>	getPertinentValuesByJoin(List<? extends Criteria> alGivenCriterias, int nLogicalAxisId, JoinStatement joinStatementAllPositions)
List<Integer>	getSilverContentIdsByPositionIds(List<Integer> alPositionids)
PertinentAxis	getSinglePertinentAxisByJoin(Connection connection, List<? extends Criteria> alCriterias, int nAxisId, String sRootValue, JoinStatement joinStatementAllPositions)
PertinentAxis	getSinglePertinentAxisByJoin(Connection connection, List<? extends Criteria> alCriterias, int nAxisId, String sRootValue, JoinStatement joinStatementAllPositions, String todayFormatted)
int	isPositionAlreadyExists(int nSilverObjectId, Position position)
void	registerAxis(Connection connection, int nLogicalAxisId)
void	replaceValuesOnAxis(Connection connection, List<Value> oldValue, List<Value> newValue)
void	unclassifySilverObject(Connection connection, int nSilverObjectId)
void	unclassifySilverObjectByPosition(Connection connection, int nSilverObjectId, Position<Value> position)
void	unclassifySilverObjectByPositionId(Connection connection, int nPositionId)
List<Integer>	unregisterAxis(Connection connection, int nLogicalAxisId)
void	updateSilverObjectPosition(Connection connection, Position newPosition)
void	updateSilverObjectPositions(Connection connection, List<Value> classifyValues, int nSilverObjectId)

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassifyEngine

public ClassifyEngine()

Method Detail

getMaxAxis

public static int getMaxAxis()

clearCache

public static void clearCache()

registerAxis

public void registerAxis(Connection connection,
                         int nLogicalAxisId)
                  throws ClassifyEngineException

Throws:

ClassifyEngineException

unregisterAxis

public List<Integer> unregisterAxis(Connection connection,
                                    int nLogicalAxisId)
                             throws ClassifyEngineException

Throws:

ClassifyEngineException

isPositionAlreadyExists

public int isPositionAlreadyExists(int nSilverObjectId,
                                   Position position)
                            throws ClassifyEngineException

Throws:

ClassifyEngineException

classifySilverObject

public int classifySilverObject(Connection connection,
                                int silverObjectId,
                                Position position)
                         throws ClassifyEngineException

Throws:

ClassifyEngineException

unclassifySilverObjectByPosition

public void unclassifySilverObjectByPosition(Connection connection,
                                             int nSilverObjectId,
                                             Position<Value> position)
                                      throws ClassifyEngineException

Throws:

ClassifyEngineException

unclassifySilverObject

public void unclassifySilverObject(Connection connection,
                                   int nSilverObjectId)
                            throws ClassifyEngineException

Throws:

ClassifyEngineException

unclassifySilverObjectByPositionId

public void unclassifySilverObjectByPositionId(Connection connection,
                                               int nPositionId)
                                        throws ClassifyEngineException

Throws:

ClassifyEngineException

updateSilverObjectPosition

public void updateSilverObjectPosition(Connection connection,
                                       Position newPosition)
                                throws ClassifyEngineException

Throws:

ClassifyEngineException

updateSilverObjectPositions

public void updateSilverObjectPositions(Connection connection,
                                        List<Value> classifyValues,
                                        int nSilverObjectId)
                                 throws ClassifyEngineException

Throws:

ClassifyEngineException

findSilverOjectByCriterias

public List<Integer> findSilverOjectByCriterias(List<Criteria> alGivenCriterias,
                                                JoinStatement joinStatementContainer,
                                                JoinStatement joinStatementContent,
                                                String afterDate,
                                                String beforeDate)
                                         throws ClassifyEngineException

Throws:

ClassifyEngineException

findSilverOjectByCriterias

public List<Integer> findSilverOjectByCriterias(List<Criteria> alGivenCriterias,
                                                JoinStatement joinStatementContainer,
                                                JoinStatement joinStatementContent,
                                                String afterDate,
                                                String beforeDate,
                                                boolean recursiveSearch,
                                                boolean visibilitySensitive)
                                         throws ClassifyEngineException

Throws:

ClassifyEngineException

getSilverContentIdsByPositionIds

public List<Integer> getSilverContentIdsByPositionIds(List<Integer> alPositionids)
                                               throws ClassifyEngineException

Throws:

ClassifyEngineException

findPositionsBySilverOjectId

public List<Position> findPositionsBySilverOjectId(int nSilverObjectId)
                                            throws ClassifyEngineException

Throws:

ClassifyEngineException

replaceValuesOnAxis

public void replaceValuesOnAxis(Connection connection,
                                List<Value> oldValue,
                                List<Value> newValue)
                         throws ClassifyEngineException

Throws:

ClassifyEngineException

getPertinentAxis

public List<PertinentAxis> getPertinentAxis(List<? extends Criteria> alGivenCriterias,
                                            List<Integer> alAxisIds)
                                     throws ClassifyEngineException

Throws:

ClassifyEngineException

getPertinentAxisByJoin

public List<PertinentAxis> getPertinentAxisByJoin(List<? extends Criteria> alGivenCriterias,
                                                  List<Integer> alAxisIds,
                                                  JoinStatement joinStatementAllPositions)
                                           throws ClassifyEngineException

Throws:

ClassifyEngineException

getSinglePertinentAxisByJoin

public PertinentAxis getSinglePertinentAxisByJoin(Connection connection,
                                                  List<? extends Criteria> alCriterias,
                                                  int nAxisId,
                                                  String sRootValue,
                                                  JoinStatement joinStatementAllPositions)
                                           throws SQLException,
                                                  ClassifyEngineException

Throws:

SQLException

ClassifyEngineException

getSinglePertinentAxisByJoin

public PertinentAxis getSinglePertinentAxisByJoin(Connection connection,
                                                  List<? extends Criteria> alCriterias,
                                                  int nAxisId,
                                                  String sRootValue,
                                                  JoinStatement joinStatementAllPositions,
                                                  String todayFormatted)
                                           throws SQLException,
                                                  ClassifyEngineException

Throws:

SQLException

ClassifyEngineException

getPertinentValues

public List<PertinentValue> getPertinentValues(List<? extends Criteria> alGivenCriterias,
                                               int nLogicalAxisId)
                                        throws ClassifyEngineException

Throws:

ClassifyEngineException

getPertinentValuesByJoin

public List<PertinentValue> getPertinentValuesByJoin(List<? extends Criteria> alGivenCriterias,
                                                     int nLogicalAxisId,
                                                     JoinStatement joinStatementAllPositions)
                                              throws ClassifyEngineException

Throws:

ClassifyEngineException

getObjectValuePairsByJoin

public List<ObjectValuePair> getObjectValuePairsByJoin(List<? extends Criteria> alGivenCriterias,
                                                       int nLogicalAxisId,
                                                       JoinStatement joinStatementAllPositions)
                                                throws ClassifyEngineException

Throws:

ClassifyEngineException

getPertinentAxisByInstanceIds

public List<Integer> getPertinentAxisByInstanceIds(List<String> instanceIds)
                                            throws ClassifyEngineException

Get axis on which some informations are classified according to given list

Parameters:

instanceIds - a List of component ids

Returns:

a List of axis id on which at least one information is classified

Throws:

ClassifyEngineException