Package com.biglybt.core.metasearch
Interface Engine
- All Known Implementing Classes:
EngineImpl
,JSONEngine
,PluginEngine
,RegexEngine
,RSSEngine
,WebEngine
public interface Engine
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
static final int
static final int
static final int
AZ_VERSION: 1: Original 2: field value substitution in JSON engine type using ${FIELD_ID} 3: field value substitution in REGEX engine type using ${FIELD_NO} 4: JSON engine now supports [x] in Entry Path, where x is the array index 5: JSON and REGEX support functions in ${FIELD_ID} or ${FIELD_NO}, such as ${1,ucase} ${1,lcase} ${1,urldecode} ${1,replace,fromRegex,toText} ${1,lcase+urldecode}static final String
static final String
static final String
static final int
static final int
static final String[]
don't change these as they are externalisedstatic final int
static final int
static final int
static final int
static final int
static final int
static final String[]
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int[]
static final int
static final String[]
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final String
static final String
static final String
static final String
static final int
static final int
static final int
static final int
static final String[]
static final Object
-
Method Summary
Modifier and TypeMethodDescriptionvoid
float
applyRankBias
(float rank) void
void
delete()
exportToBencodedMap
(boolean generic) void
exportToVuzeFile
(File target) int
int
getIcon()
long
getId()
long
getName()
float
float
int
int
int
getType()
getUID()
int
boolean
isActive()
boolean
boolean
boolean
isMine()
boolean
isPublic()
boolean
void
void
reset()
resets to initial state (e.g.boolean
sameLogicAs
(Engine other) Tests for sameness in terms of function (ignores id, selection state etc)Result[]
search
(SearchParameter[] searchParameters, Map context, int desired_max_matches, int absolute_max_matches, String headers, ResultListener listener) void
setMine
(boolean mine) void
setPreferredDelta
(float delta) void
setRankBias
(float bias) void
setSelectionState
(int state) void
setSource
(int source) boolean
supportsContext
(String context_key) boolean
supportsField
(int field_id)
-
Field Details
-
AZ_VERSION
static final int AZ_VERSIONAZ_VERSION: 1: Original 2: field value substitution in JSON engine type using ${FIELD_ID} 3: field value substitution in REGEX engine type using ${FIELD_NO} 4: JSON engine now supports [x] in Entry Path, where x is the array index 5: JSON and REGEX support functions in ${FIELD_ID} or ${FIELD_NO}, such as ${1,ucase} ${1,lcase} ${1,urldecode} ${1,replace,fromRegex,toText} ${1,lcase+urldecode}- See Also:
-
VUZE_FILE_COMPONENT_ENGINE_KEY
-
FIELD_NAME
static final int FIELD_NAME- See Also:
-
FIELD_DATE
static final int FIELD_DATE- See Also:
-
FIELD_SIZE
static final int FIELD_SIZE- See Also:
-
FIELD_PEERS
static final int FIELD_PEERS- See Also:
-
FIELD_SEEDS
static final int FIELD_SEEDS- See Also:
-
FIELD_CATEGORY
static final int FIELD_CATEGORY- See Also:
-
FIELD_COMMENTS
static final int FIELD_COMMENTS- See Also:
-
FIELD_CONTENT_TYPE
static final int FIELD_CONTENT_TYPE- See Also:
-
FIELD_DISCARD
static final int FIELD_DISCARD- See Also:
-
FIELD_VOTES
static final int FIELD_VOTES- See Also:
-
FIELD_SUPERSEEDS
static final int FIELD_SUPERSEEDS- See Also:
-
FIELD_PRIVATE
static final int FIELD_PRIVATE- See Also:
-
FIELD_DRMKEY
static final int FIELD_DRMKEY- See Also:
-
FIELD_VOTES_DOWN
static final int FIELD_VOTES_DOWN- See Also:
-
FIELD_TORRENTLINK
static final int FIELD_TORRENTLINK- See Also:
-
FIELD_CDPLINK
static final int FIELD_CDPLINK- See Also:
-
FIELD_PLAYLINK
static final int FIELD_PLAYLINK- See Also:
-
FIELD_DOWNLOADBTNLINK
static final int FIELD_DOWNLOADBTNLINK- See Also:
-
FIELD_HASH
static final int FIELD_HASH- See Also:
-
FIELD_RANK
static final int FIELD_RANK- See Also:
-
FIELD_ASSET_DATE
static final int FIELD_ASSET_DATE- See Also:
-
FIELD_IDS
static final int[] FIELD_IDS -
FIELD_NAMES
-
ENGINE_TYPE_REGEX
static final int ENGINE_TYPE_REGEX- See Also:
-
ENGINE_TYPE_JSON
static final int ENGINE_TYPE_JSON- See Also:
-
ENGINE_TYPE_PLUGIN
static final int ENGINE_TYPE_PLUGIN- See Also:
-
ENGINE_TYPE_RSS
static final int ENGINE_TYPE_RSS- See Also:
-
ENGINE_SOURCE_UNKNOWN
static final int ENGINE_SOURCE_UNKNOWN- See Also:
-
ENGINE_SOURCE_VUZE
static final int ENGINE_SOURCE_VUZE- See Also:
-
ENGINE_SOURCE_LOCAL
static final int ENGINE_SOURCE_LOCAL- See Also:
-
ENGINE_SOURCE_RSS
static final int ENGINE_SOURCE_RSS- See Also:
-
SEL_STATE_DESELECTED
static final int SEL_STATE_DESELECTED- See Also:
-
SEL_STATE_AUTO_SELECTED
static final int SEL_STATE_AUTO_SELECTED- See Also:
-
SEL_STATE_MANUAL_SELECTED
static final int SEL_STATE_MANUAL_SELECTED- See Also:
-
SEL_STATE_FORCE_DESELECTED
static final int SEL_STATE_FORCE_DESELECTED- See Also:
-
AUTO_DL_SUPPORTED_UNKNOWN
static final int AUTO_DL_SUPPORTED_UNKNOWN- See Also:
-
AUTO_DL_SUPPORTED_YES
static final int AUTO_DL_SUPPORTED_YES- See Also:
-
AUTO_DL_SUPPORTED_NO
static final int AUTO_DL_SUPPORTED_NO- See Also:
-
ENGINE_SOURCE_STRS
don't change these as they are externalised -
SEL_STATE_STRINGS
-
ENGINE_TYPE_STRS
-
SC_SOURCE
- See Also:
-
SC_FORCE_FULL
- See Also:
-
SC_BATCH_PERIOD
- See Also:
-
SC_REMOVE_DUP_HASH
- See Also:
-
CT_VIDEO
- See Also:
-
CT_AUDIO
- See Also:
-
CT_GAME
- See Also:
-
-
Method Details
-
getType
int getType() -
search
Result[] search(SearchParameter[] searchParameters, Map context, int desired_max_matches, int absolute_max_matches, String headers, ResultListener listener) throws SearchException - Throws:
SearchException
-
getName
String getName() -
getNameEx
String getNameEx() -
getId
long getId() -
getUID
String getUID() -
getVersion
int getVersion() -
getLastUpdated
long getLastUpdated() -
getIcon
String getIcon() -
getDownloadLinkCSS
String getDownloadLinkCSS() -
isActive
boolean isActive() -
isMine
boolean isMine() -
isPublic
boolean isPublic() -
setMine
void setMine(boolean mine) -
getSelectionState
int getSelectionState() -
setSelectionState
void setSelectionState(int state) -
recordSelectionState
void recordSelectionState() -
checkSelectionStateRecorded
void checkSelectionStateRecorded() -
getSource
int getSource() -
setSource
void setSource(int source) -
getReferer
String getReferer() -
getRankBias
float getRankBias() -
setRankBias
void setRankBias(float bias) -
setPreferredDelta
void setPreferredDelta(float delta) -
getPreferredWeighting
float getPreferredWeighting() -
applyRankBias
float applyRankBias(float rank) -
supportsField
boolean supportsField(int field_id) -
supportsContext
-
isAnonymous
boolean isAnonymous() -
isAuthenticated
boolean isAuthenticated() -
getAutoDownloadSupported
int getAutoDownloadSupported()- Returns:
- one of AUTO_DL constants above
-
getAZVersion
int getAZVersion() -
addPotentialAssociation
-
getSubscription
Subscription getSubscription() -
exportToBencodedMap
- Throws:
IOException
-
exportToBencodedMap
- Throws:
IOException
-
exportToJSONString
- Throws:
IOException
-
exportToVuzeFile
- Throws:
IOException
-
exportToVuzeFile
- Throws:
IOException
-
sameLogicAs
Tests for sameness in terms of function (ignores id, selection state etc)- Parameters:
other
-- Returns:
-
reset
void reset()resets to initial state (e.g. if the engine has state pertaining to what has/hasn't been downloaded such as etags then this will be cleared) -
delete
void delete() -
getString
String getString()
-