AbstractNSearchCmd (Nuts Community Core Runtime 0.8.8.0 API)

java.lang.Object
- net.thevpc.nuts.runtime.standalone.workspace.cmd.NWorkspaceCmdBase<T>
- - net.thevpc.nuts.runtime.standalone.workspace.cmd.DefaultNQueryBaseOptions<NSearchCmd>
  - - net.thevpc.nuts.runtime.standalone.workspace.cmd.search.AbstractNSearchCmd

All Implemented Interfaces:

NCmdLineConfigurable, NSearchCmd, NWorkspaceCmd, NComponent, NScorable

Direct Known Subclasses:

DefaultNSearchCmd, RemoteNSearchCmd
```
public abstract class AbstractNSearchCmd
extends DefaultNQueryBaseOptions<NSearchCmd>
implements NSearchCmd
```
Author:

thevpc

Field Summary

Fields
Modifier and Type	Field and Description
`protected NComparator`	`comparator`
`protected NDefinitionFilter`	`definitionFilter`
`protected boolean`	`describe`
`protected boolean`	`distinct`
`protected SearchExecType`	`execType`
`protected List<NId>`	`ids`
`protected boolean`	`ignoreCurrentEnvironment`
`protected boolean`	`includeBasePackage`
`protected boolean`	`latest`
`protected boolean`	`sorted`
`protected NVersion`	`targetApiVersion`

Fields inherited from class net.thevpc.nuts.runtime.standalone.workspace.cmd.DefaultNQueryBaseOptions
dependencyFilter

Fields inherited from interface net.thevpc.nuts.util.NScorable
CUSTOM_SCORE, DEFAULT_SCORE, UNSUPPORTED_SCORE

Constructor Summary

Constructors
Constructor and Description

AbstractNSearchCmd()

Constructors
Constructor and Description
`AbstractNSearchCmd()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`NSearchCmd`	`addDefinitionFilter(NDefinitionFilter filter)`
`NSearchCmd`	`addId(NId id)`
`NSearchCmd`	`addId(String id)`
`NSearchCmd`	`addIds(NId... value)`
`NSearchCmd`	`addIds(String... values)`
`protected NIterator<NId>`	`applyPrintDecoratorIterOfNutsId(NIterator<NId> curr, boolean print)`
`protected <T> NStream<T>`	`buildCollectionResult(NIterator<T> o)`
`NSearchCmd`	`clearIds()`
`boolean`	`configureFirst(NCmdLine cmdLine)`
`NSearchCmd`	`copyFrom(NFetchCmd other)`
`NSearchCmd`	`copyFrom(NSearchCmd other)`
`NSearchCmd`	`distinct()`
`NComparator`	`getComparator()`
`NDefinitionFilter`	`getDefinitionFilter()`
`SearchExecType`	`getExecType()`
`List<NId>`	`getIds()`
`NStream<String>`	`getResultArch()`
`ClassLoader`	`getResultClassLoader()`
`ClassLoader`	`getResultClassLoader(ClassLoader parent)`
`String`	`getResultClassPath()`
`NIterator<NDefinition>`	`getResultDefinitionIteratorBase()`
`NStream<NDefinition>`	`getResultDefinitions()`
`NStream<NDependencies>`	`getResultDependencies()`
`NStream<NDescriptor>`	`getResultDescriptors()`
`NStream<String>`	`getResultDesktopEnvironment()`
`NStream<NExecutionEntry>`	`getResultExecutionEntries()`
`protected abstract NIterator<NId>`	`getResultIdIteratorBase(Boolean forceInlineDependencies)`
`NStream<NId>`	`getResultIds()`
`protected NStream<NId>`	`getResultIdsBase(boolean sort)`
`NStream<NDependency>`	`getResultInlineDependencies()`
`NStream<Instant>`	`getResultInstallDates()`
`NStream<NPath>`	`getResultInstallFolders()`
`NStream<String>`	`getResultInstallUsers()`
`NStream<String>`	`getResultNames()`
`String`	`getResultNutsPath()`
`NStream<String>`	`getResultOs()`
`NStream<String>`	`getResultOsDist()`
`NStream<String>`	`getResultPackaging()`
`NStream<String>`	`getResultPathNames()`
`NStream<String>`	`getResultPaths()`
`NStream<String>`	`getResultPlatform()`
`NStream<String>`	`getResultProfile()`
`NElement`	`getResultQueryPlan()`
`NStream<String>`	`getResultStatuses()`
`NStream<NPath>`	`getResultStoreLocations(NStoreType location)`
`NStream<String[]>`	`getResultStrings(String[] columns)`
`int`	`getScore(NScorableContext context)`
`protected NSession`	`getSearchSession()`
`NVersion`	`getTargetApiVersion()`
`boolean`	`isBasePackage()`
`boolean`	`isCompanion()`
`boolean`	`isDistinct()`
`boolean`	`isExec()`
`boolean`	`isExtension()`
`boolean`	`isIgnoreCurrentEnvironment()`
`boolean`	`isLatest()`
`boolean`	`isLib()`
`boolean`	`isNutsApplication()`
`boolean`	`isPlatformApplication()`
`boolean`	`isRuntime()`
`boolean`	`isSorted()`
`NSearchCmd`	`latest()`
`protected <T> NStream<T>`	`postProcessResult(NIteratorBuilder<T> a)`
`NSearchCmd`	`removeId(NId id)`
`NSearchCmd`	`removeId(String id)`
`protected String`	`resolveFindIdBase()`
`NSearchCmd`	`run()`
`<T> NIterator<T>`	`runIterator()`
`NSearchCmd`	`setBasePackage(boolean includeBasePackage)`
`NSearchCmd`	`setCompanion(boolean enable)`
`NSearchCmd`	`setDefinitionFilter(NDefinitionFilter filter)`
`NSearchCmd`	`setDistinct(boolean distinct)`
`NSearchCmd`	`setExec(boolean enable)`
`NSearchCmd`	`setExtension(boolean enable)`
`NSearchCmd`	`setId(NId id)`
`NSearchCmd`	`setId(String id)`
`NSearchCmd`	`setIds(NId... ids)`
`NSearchCmd`	`setIds(String... ids)`
`NSearchCmd`	`setIgnoreCurrentEnvironment(boolean ignoreCurrentEnvironment)`
`NSearchCmd`	`setLatest(boolean enable)`
`NSearchCmd`	`setLib(boolean enable)`
`NSearchCmd`	`setNutsApplication(boolean enable)`
`NSearchCmd`	`setPlatformApplication(boolean enable)`
`NSearchCmd`	`setRuntime(boolean enable)`
`NSearchCmd`	`setSorted(boolean sort)`
`NSearchCmd`	`setTargetApiVersion(NVersion targetApiVersion)`
`NSearchCmd`	`sort(Comparator<?> comparator)`
`String`	`toString()`

Methods inherited from class net.thevpc.nuts.runtime.standalone.workspace.cmd.DefaultNQueryBaseOptions
addDependencyFilter, addRepositoryFilter, copyFromDefaultNQueryBaseOptions, failFast, getDependencyFilter, getDisplayOptions, getExpireTime, getFetchStrategy, getRepositoryFilter, getTransitive, isFailFast, isInlineDependencies, setDependencyFilter, setDependencyFilter, setExpireTime, setFailFast, setFetchStrategy, setInlineDependencies, setRepositoryFilter, setTransitive

Methods inherited from class net.thevpc.nuts.runtime.standalone.workspace.cmd.NWorkspaceCmdBase
_LOG, configure, copyFromWorkspaceCommandBase, getCommandName, invalidateResult

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.thevpc.nuts.command.NSearchCmd
addDependencyFilter, addRepositoryFilter, configure, copy, failFast, getDependencyFilter, getExpireTime, getFetchStrategy, getRepositoryFilter, getTransitive, isFailFast, isInlineDependencies, of, of, of, setDependencyFilter, setDependencyFilter, setExpireTime, setFailFast, setFetchStrategy, setInlineDependencies, setRepositoryFilter, setTransitive, toFetch

Methods inherited from interface net.thevpc.nuts.cmdline.NCmdLineConfigurable
configure, configure, configureLast

Methods inherited from interface net.thevpc.nuts.util.NScorable
isValidScore, query, query

- Field Detail
  - ids
```
protected final List<NId> ids
```
  - comparator
```
protected NComparator comparator
```
  - definitionFilter
```
protected NDefinitionFilter definitionFilter
```
  - latest
```
protected boolean latest
```
  - distinct
```
protected boolean distinct
```
  - includeBasePackage
```
protected boolean includeBasePackage
```
  - sorted
```
protected boolean sorted
```
  - ignoreCurrentEnvironment
```
protected boolean ignoreCurrentEnvironment
```
  - describe
```
protected boolean describe
```
  - execType
```
protected SearchExecType execType
```
  - targetApiVersion
```
protected NVersion targetApiVersion
```
- Constructor Detail
  - AbstractNSearchCmd
```
public AbstractNSearchCmd()
```
- Method Detail
  - isIgnoreCurrentEnvironment
```
public boolean isIgnoreCurrentEnvironment()
```
    Specified by:
    
    isIgnoreCurrentEnvironment in interface NSearchCmd
  - setIgnoreCurrentEnvironment
```
public NSearchCmd setIgnoreCurrentEnvironment(boolean ignoreCurrentEnvironment)
```
    Specified by:
    
    setIgnoreCurrentEnvironment in interface NSearchCmd
  - getScore
```
public int getScore(NScorableContext context)
```
    Specified by:
    
    getScore in interface NComponent
    
    Specified by:
    
    getScore in interface NScorable
    
    Overrides:
    
    getScore in class NWorkspaceCmdBase<NSearchCmd>
  - clearIds
```
public NSearchCmd clearIds()
```
    Specified by:
    
    clearIds in interface NSearchCmd
  - addId
```
public NSearchCmd addId(String id)
```
    Specified by:
    
    addId in interface NSearchCmd
  - addId
```
public NSearchCmd addId(NId id)
```
    Specified by:
    
    addId in interface NSearchCmd
  - addIds
```
public NSearchCmd addIds(String... values)
```
    Specified by:
    
    addIds in interface NSearchCmd
  - addIds
```
public NSearchCmd addIds(NId... value)
```
    Specified by:
    
    addIds in interface NSearchCmd
  - removeId
```
public NSearchCmd removeId(String id)
```
    Specified by:
    
    removeId in interface NSearchCmd
  - removeId
```
public NSearchCmd removeId(NId id)
```
    Specified by:
    
    removeId in interface NSearchCmd
  - isRuntime
```
public boolean isRuntime()
```
    Specified by:
    
    isRuntime in interface NSearchCmd
  - setRuntime
```
public NSearchCmd setRuntime(boolean enable)
```
    Specified by:
    
    setRuntime in interface NSearchCmd
  - isCompanion
```
public boolean isCompanion()
```
    Specified by:
    
    isCompanion in interface NSearchCmd
  - setCompanion
```
public NSearchCmd setCompanion(boolean enable)
```
    Specified by:
    
    setCompanion in interface NSearchCmd
  - isExtension
```
public boolean isExtension()
```
    Specified by:
    
    isExtension in interface NSearchCmd
  - setExtension
```
public NSearchCmd setExtension(boolean enable)
```
    Specified by:
    
    setExtension in interface NSearchCmd
  - isExec
```
public boolean isExec()
```
    Specified by:
    
    isExec in interface NSearchCmd
  - setExec
```
public NSearchCmd setExec(boolean enable)
```
    Specified by:
    
    setExec in interface NSearchCmd
  - isNutsApplication
```
public boolean isNutsApplication()
```
    Specified by:
    
    isNutsApplication in interface NSearchCmd
  - setNutsApplication
```
public NSearchCmd setNutsApplication(boolean enable)
```
    Specified by:
    
    setNutsApplication in interface NSearchCmd
  - isPlatformApplication
```
public boolean isPlatformApplication()
```
    Specified by:
    
    isPlatformApplication in interface NSearchCmd
  - setPlatformApplication
```
public NSearchCmd setPlatformApplication(boolean enable)
```
    Specified by:
    
    setPlatformApplication in interface NSearchCmd
  - isLib
```
public boolean isLib()
```
    Specified by:
    
    isLib in interface NSearchCmd
  - setLib
```
public NSearchCmd setLib(boolean enable)
```
    Specified by:
    
    setLib in interface NSearchCmd
  - sort
```
public NSearchCmd sort(Comparator<?> comparator)
```
    Specified by:
    
    sort in interface NSearchCmd
  - copyFrom
```
public NSearchCmd copyFrom(NSearchCmd other)
```
    Specified by:
    
    copyFrom in interface NSearchCmd
  - copyFrom
```
public NSearchCmd copyFrom(NFetchCmd other)
```
    Specified by:
    
    copyFrom in interface NSearchCmd
  - getIds
```
public List<NId> getIds()
```
    Specified by:
    
    getIds in interface NSearchCmd
  - setIds
```
public NSearchCmd setIds(String... ids)
```
    Specified by:
    
    setIds in interface NSearchCmd
  - setIds
```
public NSearchCmd setIds(NId... ids)
```
    Specified by:
    
    setIds in interface NSearchCmd
  - isSorted
```
public boolean isSorted()
```
    Specified by:
    
    isSorted in interface NSearchCmd
  - setSorted
```
public NSearchCmd setSorted(boolean sort)
```
    Specified by:
    
    setSorted in interface NSearchCmd
  - getDefinitionFilter
```
public NDefinitionFilter getDefinitionFilter()
```
    Specified by:
    
    getDefinitionFilter in interface NSearchCmd
  - setDefinitionFilter
```
public NSearchCmd setDefinitionFilter(NDefinitionFilter filter)
```
    Specified by:
    
    setDefinitionFilter in interface NSearchCmd
  - addDefinitionFilter
```
public NSearchCmd addDefinitionFilter(NDefinitionFilter filter)
```
    Specified by:
    
    addDefinitionFilter in interface NSearchCmd
  - getComparator
```
public NComparator getComparator()
```
    Specified by:
    
    getComparator in interface NSearchCmd
  - isDistinct
```
public boolean isDistinct()
```
    Specified by:
    
    isDistinct in interface NSearchCmd
  - setDistinct
```
public NSearchCmd setDistinct(boolean distinct)
```
    Specified by:
    
    setDistinct in interface NSearchCmd
  - distinct
```
public NSearchCmd distinct()
```
    Specified by:
    
    distinct in interface NSearchCmd
  - getTargetApiVersion
```
public NVersion getTargetApiVersion()
```
    Specified by:
    
    getTargetApiVersion in interface NSearchCmd
  - setTargetApiVersion
```
public NSearchCmd setTargetApiVersion(NVersion targetApiVersion)
```
    Specified by:
    
    setTargetApiVersion in interface NSearchCmd
  - isBasePackage
```
public boolean isBasePackage()
```
    Specified by:
    
    isBasePackage in interface NSearchCmd
  - setBasePackage
```
public NSearchCmd setBasePackage(boolean includeBasePackage)
```
    Specified by:
    
    setBasePackage in interface NSearchCmd
  - isLatest
```
public boolean isLatest()
```
    Specified by:
    
    isLatest in interface NSearchCmd
  - setLatest
```
public NSearchCmd setLatest(boolean enable)
```
    Specified by:
    
    setLatest in interface NSearchCmd
  - latest
```
public NSearchCmd latest()
```
    Specified by:
    
    latest in interface NSearchCmd
  - getResultIds
```
public NStream<NId> getResultIds()
```
    Specified by:
    
    getResultIds in interface NSearchCmd
  - getResultDependencies
```
public NStream<NDependencies> getResultDependencies()
```
    Specified by:
    
    getResultDependencies in interface NSearchCmd
  - getResultInlineDependencies
```
public NStream<NDependency> getResultInlineDependencies()
```
    Specified by:
    
    getResultInlineDependencies in interface NSearchCmd
  - getResultDefinitions
```
public NStream<NDefinition> getResultDefinitions()
```
    Specified by:
    
    getResultDefinitions in interface NSearchCmd
  - getResultDescriptors
```
public NStream<NDescriptor> getResultDescriptors()
```
    Specified by:
    
    getResultDescriptors in interface NSearchCmd
  - getResultClassLoader
```
public ClassLoader getResultClassLoader()
```
    Specified by:
    
    getResultClassLoader in interface NSearchCmd
  - getResultClassLoader
```
public ClassLoader getResultClassLoader(ClassLoader parent)
```
    Specified by:
    
    getResultClassLoader in interface NSearchCmd
  - getResultNutsPath
```
public String getResultNutsPath()
```
    Specified by:
    
    getResultNutsPath in interface NSearchCmd
  - getResultClassPath
```
public String getResultClassPath()
```
    Specified by:
    
    getResultClassPath in interface NSearchCmd
  - getResultPaths
```
public NStream<String> getResultPaths()
```
    Specified by:
    
    getResultPaths in interface NSearchCmd
  - getResultPathNames
```
public NStream<String> getResultPathNames()
```
    Specified by:
    
    getResultPathNames in interface NSearchCmd
  - getResultInstallDates
```
public NStream<Instant> getResultInstallDates()
```
    Specified by:
    
    getResultInstallDates in interface NSearchCmd
  - getResultInstallUsers
```
public NStream<String> getResultInstallUsers()
```
    Specified by:
    
    getResultInstallUsers in interface NSearchCmd
  - getResultInstallFolders
```
public NStream<NPath> getResultInstallFolders()
```
    Specified by:
    
    getResultInstallFolders in interface NSearchCmd
  - getResultStoreLocations
```
public NStream<NPath> getResultStoreLocations(NStoreType location)
```
    Specified by:
    
    getResultStoreLocations in interface NSearchCmd
  - getResultStrings
```
public NStream<String[]> getResultStrings(String[] columns)
```
    Specified by:
    
    getResultStrings in interface NSearchCmd
  - getResultNames
```
public NStream<String> getResultNames()
```
    Specified by:
    
    getResultNames in interface NSearchCmd
  - getResultOs
```
public NStream<String> getResultOs()
```
    Specified by:
    
    getResultOs in interface NSearchCmd
  - getResultExecutionEntries
```
public NStream<NExecutionEntry> getResultExecutionEntries()
```
    Specified by:
    
    getResultExecutionEntries in interface NSearchCmd
  - getResultOsDist
```
public NStream<String> getResultOsDist()
```
    Specified by:
    
    getResultOsDist in interface NSearchCmd
  - getResultPackaging
```
public NStream<String> getResultPackaging()
```
    Specified by:
    
    getResultPackaging in interface NSearchCmd
  - getResultPlatform
```
public NStream<String> getResultPlatform()
```
    Specified by:
    
    getResultPlatform in interface NSearchCmd
  - getResultProfile
```
public NStream<String> getResultProfile()
```
    Specified by:
    
    getResultProfile in interface NSearchCmd
  - getResultDesktopEnvironment
```
public NStream<String> getResultDesktopEnvironment()
```
    Specified by:
    
    getResultDesktopEnvironment in interface NSearchCmd
  - getResultArch
```
public NStream<String> getResultArch()
```
    Specified by:
    
    getResultArch in interface NSearchCmd
  - setId
```
public NSearchCmd setId(String id)
```
    Specified by:
    
    setId in interface NSearchCmd
  - setId
```
public NSearchCmd setId(NId id)
```
    Specified by:
    
    setId in interface NSearchCmd
  - getExecType
```
public SearchExecType getExecType()
```
  - configureFirst
```
public boolean configureFirst(NCmdLine cmdLine)
```
    Specified by:
    
    configureFirst in interface NCmdLineConfigurable
    
    Overrides:
    
    configureFirst in class DefaultNQueryBaseOptions<NSearchCmd>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class DefaultNQueryBaseOptions<NSearchCmd>
  - runIterator
```
public <T> NIterator<T> runIterator()
```
  - getResultQueryPlan
```
public NElement getResultQueryPlan()
```
    Specified by:
    
    getResultQueryPlan in interface NSearchCmd
  - run
```
public NSearchCmd run()
```
    Specified by:
    
    run in interface NSearchCmd
    
    Specified by:
    
    run in interface NWorkspaceCmd
  - getResultDefinitionIteratorBase
```
public NIterator<NDefinition> getResultDefinitionIteratorBase()
```
  - buildCollectionResult
```
protected <T> NStream<T> buildCollectionResult(NIterator<T> o)
```
  - resolveFindIdBase
```
protected String resolveFindIdBase()
```
  - getResultStatuses
```
public NStream<String> getResultStatuses()
```
  - getResultIdIteratorBase
```
protected abstract NIterator<NId> getResultIdIteratorBase(Boolean forceInlineDependencies)
```
  - getResultIdsBase
```
protected NStream<NId> getResultIdsBase(boolean sort)
```
  - postProcessResult
```
protected <T> NStream<T> postProcessResult(NIteratorBuilder<T> a)
```
  - getSearchSession
```
protected NSession getSearchSession()
```
  - applyPrintDecoratorIterOfNutsId
```
protected NIterator<NId> applyPrintDecoratorIterOfNutsId(NIterator<NId> curr,
                                                         boolean print)
```

Class AbstractNSearchCmd

Field Summary

Fields inherited from class net.thevpc.nuts.runtime.standalone.workspace.cmd.DefaultNQueryBaseOptions

Fields inherited from interface net.thevpc.nuts.util.NScorable

Constructor Summary

Method Summary

Methods inherited from class net.thevpc.nuts.runtime.standalone.workspace.cmd.DefaultNQueryBaseOptions

Methods inherited from class net.thevpc.nuts.runtime.standalone.workspace.cmd.NWorkspaceCmdBase

Methods inherited from class java.lang.Object

Methods inherited from interface net.thevpc.nuts.command.NSearchCmd

Methods inherited from interface net.thevpc.nuts.cmdline.NCmdLineConfigurable

Methods inherited from interface net.thevpc.nuts.util.NScorable

Field Detail

ids

comparator

definitionFilter

latest

distinct

includeBasePackage

sorted

ignoreCurrentEnvironment

describe

execType

targetApiVersion

Constructor Detail

AbstractNSearchCmd

Method Detail

isIgnoreCurrentEnvironment

setIgnoreCurrentEnvironment

getScore

clearIds

addId

addId

addIds

addIds

removeId

removeId

isRuntime

setRuntime

isCompanion

setCompanion

isExtension

setExtension

isExec

setExec

isNutsApplication

setNutsApplication

isPlatformApplication

setPlatformApplication

isLib

setLib

sort

copyFrom

copyFrom

getIds

setIds

setIds

isSorted

setSorted

getDefinitionFilter

setDefinitionFilter

addDefinitionFilter

getComparator

isDistinct

setDistinct

distinct

getTargetApiVersion

setTargetApiVersion

isBasePackage

setBasePackage

isLatest

setLatest

latest

getResultIds

getResultDependencies

getResultInlineDependencies

getResultDefinitions

getResultDescriptors

getResultClassLoader

getResultClassLoader