/**
* Copyright (c) 2011, SOCIETIES Consortium (WATERFORD INSTITUTE OF TECHNOLOGY (TSSG), HERIOT-WATT UNIVERSITY (HWU), SOLUTA.NET
* (SN), GERMAN AEROSPACE CENTRE (Deutsches Zentrum fuer Luft- und Raumfahrt e.V.) (DLR), Zavod za varnostne tehnologije
* informacijske družbe in elektronsko poslovanje (SETCCE), INSTITUTE OF COMMUNICATION AND COMPUTER SYSTEMS (ICCS), LAKE
* COMMUNICATIONS (LAKE), INTEL PERFORMANCE LEARNING SOLUTIONS LTD (INTEL), PORTUGAL TELECOM INOVAÇÃO, SA (PTIN), IBM Corp.,
* INSTITUT TELECOM (ITSUD), AMITEC DIACHYTI EFYIA PLIROFORIKI KAI EPIKINONIES ETERIA PERIORISMENIS EFTHINIS (AMITEC), TELECOM
* ITALIA S.p.a.(TI), TRIALOG (TRIALOG), Stiftelsen SINTEF (SINTEF), NEC EUROPE LTD (NEC))
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following
* conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
* BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
* SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.societies.context.api.community.inference;
import java.util.Date;
import java.util.List;
import java.util.Map;
import org.societies.api.identity.IIdentity;
import org.societies.api.context.model.CtxAttribute;
import org.societies.api.context.model.CtxAttributeIdentifier;
import org.societies.api.context.model.CtxAttributeValueType;
import org.societies.api.context.model.CtxEntityIdentifier;
/**
* @author nikosk
* @created 12-Nov-2011 7:15:15 PM
*/
public interface ICommunityCtxInferenceMgr {
/**
* This method initiates the estimation of a community context attribute value. The method returns the ctxAttribute with
* the estimated value that is assigned to a Community Context Entity.
*
* @param communityCtxEntityID the community Entity identifier
* @param ctxAttrId the context attribute id
* @return ctxAttribute object
*/
public CtxAttribute estimateCommunityContext(CtxEntityIdentifier communityCtxEntityID, CtxAttributeIdentifier ctxAttrId);
/**
* Evaluates the similatiry of two indicated Community Context Attributes.
*
* @param ctxID1
* @param ctxID2
* @return a number indicating the objects similarity
* @since 0.0.1
*/
public Double evaluateSimilarity(CtxAttributeIdentifier ctxID1, CtxAttributeIdentifier ctxID2);
/**
* This method returns a linked map with key the recorded
* CtxAttributeIdentifier and value the result of the
* similarity evaluation.
*
* @param listCtxID1
* @param listCtxID2
* @since 0.0.1
*/
public Map<CtxAttributeIdentifier,Double> evaluateSimilarity(List<CtxAttributeIdentifier> listCtxID1, List<CtxAttributeIdentifier> listCtxID2);
/**
* Inherits the Community Context Attribute belonging to a CIS.
*
* @param ctxAttrId
* @param type
* @param cisid
* @since 0.0.1
*/
public void inheritContext(CtxAttributeIdentifier ctxAttrId, CtxAttributeValueType type, IIdentity cisid);
/**
* Predicts context using indicated date.
*
* @param ctxAttrID
* @param date
* @returns context attribute with predicted context
* @since 0.0.1
*/
public CtxAttribute predictContext(CtxAttributeIdentifier ctxAttrID, Date date);
/**
* Predicts context using indicated index.
*
* @param ctxAttrID
* @param index
* @returns context attribute with predicted context
* @since 0.0.1
*/
public CtxAttribute predictContext(CtxAttributeIdentifier ctxAttrID, int index );
/**
* Refines context for an indicate Context Attribute.
*
* @param ctxAttrId
* @since 0.0.1
*/
public void refineContext(CtxAttributeIdentifier ctxAttrId);
/**
* Returns a list of CtxAttributeTypes that can be inferred.
*
* @return Set of ctxAttributeTypes
* @since 0.0.8
*/
public List<String> getInferrableTypes();
}